Archive Success Plan Goal
POST/api/success-plan/goals/:goal/archive
Archives a goal. Its readings are kept, it no longer counts toward the three active goals, and it can't be changed afterwards. No body.
success_plan:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token with the success_plan:write scope. The user must hold the success_plan.manage permission.
Returns the goal with status: archived and archived_at.
409 goal_busy: SKU.io was measuring this goal and did not finish in time; nothing was saved, so retry shortly.
Request
Responses
- 200
- 401
- 403
- 404
- 409
- 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
Response Headers
Conflict
Response Headers
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.