Respond to Goal Met

POST 
/api/success-plan/goal-met/:goal/respond

Answers the "you hit your goal" ask for a met goal, once per goal.

Required scope: success_plan:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

• sentence: your sentence becomes a quote in your own words, used in a draft only once you approve it.
• clip / write_up: an offer to record a short clip or help with a write-up; SKU.io follows up.
• not_now: dismissed; consent that was never set becomes ask_later.
• never: consent becomes no.

Authentication: Requires Bearer token with the success_plan:write scope. The user must hold the success_plan.manage permission.

Body:

• choice (string, required): sentence, clip, write_up, not_now or never.
• text (string, max 500): required with sentence.

Response: goal_id, choice, story_entry (the quote or offer recorded, or null) and consent_status.

409 codes: consent_no (sharing is off), goal_not_met, already_responded.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not Found

Response Headers

Content-Type

409

Conflict

Response Headers

Content-Type

422

Unprocessable Entity

Response Headers

Content-Type

429

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.