Bulk Update Account Settings
POST/api/admin/portal/accounts/bulk-settings
Set the ship-to policy on many portal accounts at once. Requires the portal.manage permission. Ids that are not portal accounts (or do not exist) are skipped; updated is the number of accounts changed.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Request fields
customer_ids(array of distinct integers, required, 1–1000): the accounts' customer ids.portal_ship_to_policy(string or null, required — the key must be present):saved_only(buyers may only ship to saved addresses),may_add_saved(buyers may add new addresses, which are saved to the account),may_ship_anywhere(buyers may also ship to a one-time address that is not saved).nullputs the accounts back on the tenant default (default_ship_to_policyin the portal settings,may_add_savedunless changed).
Errors. 422 when customer_ids is missing, empty, over 1000 or has duplicates, or the policy key is missing or unknown.
Request
Responses
- 200
- 401
- 403
- 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.
Unprocessable Content
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.