Skip to main content

Approve Send Run Network

POST 

/api/send-plans/:sendPlan/approvals

Approve one network's send in a send run at its current quantity. Approving a network already approved at that quantity changes nothing; an approval of an older quantity is replaced, and the replacement is recorded.

Required scope: send-plans:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Bearer Personal Access Token with the send-plans:write scope. The token's user also needs permission to edit the send planner.

Body fields:

  • destination_warehouse_id (integer, required): the network to approve.

Response data: networks — per enabled network: destination_warehouse_id, network, label, units, requires_approval (it has units to send), approved (approved at its current quantity), stale (approved, but its units changed since) and approval (id, approved_units, approved_at, approved_by); required_count, approved_count, all_approved; and history — every approval and withdrawal, newest first (action approved | revoked, destination_warehouse_id, label, units, user, at).

Returns 422 when the plan is not a ready send run, the network is not part of the run, or nothing is going to it.

Request​

Responses​

OK

Response Headers
    Content-Type