Update Recovery Settings
PUT/api/amazon/unified/recovery/settings/:integrationInstance
Partially updates the Amazon Recovery settings for one Amazon integration. Every field is optional; only the fields you send are changed. Changes apply to opportunities found from now on — existing cases are not removed or re-evaluated. Requires the integrations update permission.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Request body fields:
enabled_categories(object, optional) — category key → boolean. Only the categories you name change; the rest keep their current toggle. Unknown category keys are rejected. Categories: warehouse_lost, warehouse_damaged, customer_return_not_received, customer_return_damaged, customer_return_refund_mismatch, inbound_shortage, removal_order_discrepancy, fba_fee_overcharge, chargeback_reversal, destroyed_without_authorization, return_not_restocked, underpaid_reimbursement, reimbursed_then_returned.min_amount(number, optional, nullable, 0–1000000) — minimum potential amount for a new opportunity to be surfaced; null or 0 clears it.default_assignee_user_id(integer, optional, nullable) — must be a member of the current account; null clears it.weekly_digest_opt_in(boolean, optional).
Returns the full settings object (same shape as Get Recovery Settings).
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.