Skip to main content

Mark Success Plan Goal Met

POST 

/api/success-plan/goals/:goal/met

Marks a goal with no target as met ("We got there"). Goals with a target are marked met by SKU.io when a reading reaches it, so they answer 422 goal_has_target. The goal-met result is logged in the story, and the goal becomes eligible for the goal-met response (see Respond to Goal Met).

Required scope: success_plan:write

Grant 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.

Body (everything optional, under met or at the top level):

  • met.value (number): the value reached.
  • met.as_of (date Y-m-d, not in the future).
  • met.source_note (string, max 255).
  • met.evidence (string): document, system_export or estimate.
  • met.attachment_ids (integer array, max 10): only with document or system_export.

Returns the goal with status: met and met_at.

409 goal_busy: SKU.io was measuring this goal and did not finish in time; nothing was saved, so retry shortly.

Request​

Responses​

OK

Response Headers
    Content-Type