Promote Scenario
POST/api/send-plans/:sendPlan/promote
Turn a scenario into the working plan: a new working plan is calculated in the background with the scenario's scope and rule overrides, and its parent_send_plan_id points at the scenario. Returns 202 with the new plan's ID.
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.
No request body. Returns 422 when the plan is not a scenario.
Request
Responses
- 202
- 401
- 403
- 404
- 422
- 429
Accepted
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.