Archive Account Rule
POST/api/product-account-rules/:rule/archive
Archive an account rule. Archived rules never match (whatever their is_active flag), are hidden from the list by default and are skipped by the evaluation order; reorder requests ignore them.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token with the accounting:write scope. No request body.
Every change to the rule set queues a background run that re-applies the rules to the whole catalog. Its id is returned as tracked_job_id; poll GET /api/tracked-job-logs/{trackedJobLog} to follow it. A newer change supersedes a run that is still queued or running.
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
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.