Update Packaging Exclusions
PUT/api/success-plan/settings/exclusions
Replaces the packaging and consumables exclusion list. Provisional months are re-measured in the background (remeasure_queued: true); settled months keep their figures until you run Recompute Measured History.
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:
category_ids(integer array, required, may be empty, max 200, distinct): product category IDs.tags(string array, required, may be empty, max 200, distinct, each max 100).product_ids(integer array, required, may be empty, max 2000, distinct): product IDs.include_decoration_consumables(boolean, optional, default true).
Returns the saved list.
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.