Recompute Measured History
POST/api/success-plan/settings/exclusions/recompute
Re-measures every month since go-live (at most 26) with the current exclusion list. A settled month whose figure changed is restated: the old reading is kept and the new one carries the reason. Runs before it responds, so it can take a little while.
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.
Body:
reason(string, optional, 3–255): the restatement reason; defaults to "exclusion list changed".
Response: restated (settled months whose figure changed), refreshed (other readings re-measured), months and reason.
Request
Responses
- 200
- 401
- 403
- 404
- 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
Unprocessable Entity
Response Headers
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.