Skip to main content

Update Success Plan Goal

PATCH 

/api/success-plan/goals/:goal

Edits a goal's title, target value or target date. Send only the fields to change. The unit can't change (archive the goal and add a new one), and the baseline is never overwritten here: use Correct Goal Baseline.

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:

  • title (string, 5–200).
  • target.value (number or null): null removes the target, making the goal one you mark met yourself.
  • target.by_date (date Y-m-d, in the future).
  • baseline, unit: not allowed (422).

Returns the goal. A change is recorded in the story log. Archived goals answer 422 goal_archived.

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