Upsert Network Capacity Limit
PUT/api/send-planner/capacity
Set a network's storage capacity limit for a month (one limit per destination, month and storage type). Plans trim sends that would exceed the current month's limit, lowest priority first, and flag the trimmed lines capacity_cap.
send-plans:writeGrant 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): must exist.
- period_start (string, required, YYYY-MM): the month.
- storage_type (string, required): standard | oversize | apparel | footwear | units.
- limit_value (number, required, 0-100000000).
- unit (string, required): cu_ft | units.
- note (string, max 255, nullable).
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.