Block Launch Step
POST/api/launch-plan/steps/:step/block
Marks an open step blocked: what it is waiting for and who it is waiting on.
launch_plan:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
reason(required, up to 300 characters).on(required) —sku(waiting on SKU.io),customer(waiting on you) orthird_party(a 3PL, channel, accountant…).
While blocked the step is at risk with the reason Blocked: <reason> (waiting on SKU|you|a third party), and off track once it has been blocked more than 5 days; a step blocked 5 days or more leads the plan's health reason, and the digest lists blocked steps first. Blocking an already-blocked step replaces the reason and who but keeps when it was first blocked. Ticking the step done or signing it off clears the mark; so does it completing from data. The change is recorded in the step's activity (blocked).
Response: the full launch plan, as returned by Get Launch Plan ({data, exists: true}), with health recomputed. 422 for a step that is already done or marked not needed, or a missing / invalid reason or on. 404 for an unknown step or when the account has no plan.
Authentication: Requires Bearer token with the launch_plan:write scope. The user needs the launch_plan.manage permission.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.