Snooze Check-in
POST/api/success-plan/check-ins/:checkIn/snooze
Postpones a due check-in by 14 days. A check-in can be snoozed twice; after that it can still be answered at any time. 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.
409 codes: not_snoozable (only a due check-in can be snoozed) and snooze_limit.
Check-in objects carry id, kind (go_live_14, day_30, day_90, day_180, year_end), title, due_on, status (scheduled, due, snoozed, answered, skipped, lapsed) with status_label, snoozed_until, snooze_count, can_snooze, can_answer, answered_by, answered_at, questions and answers. Questions are fixed the first time a check-in is due; each has a key, goal_id, label, input (number, roles_hours, yes_no, yes_partly_no, checklist, text), unit, optional, previous_reading_id and, for a checklist, items. The schedule is in Get Success Plan (check_ins). Answers in your own words (text) are customer text: show them as plain text, never as HTML.
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.