Skip to main content
PATCH
Suspends or reactivates an organization with an API key. Account-wide keys can change any organization in the account, and reseller-scoped keys only organizations under their reseller. Organization-scoped keys are refused with 403 insufficient_scope, so an organization cannot reactivate itself. In the dashboard, account admins and Reseller Admins use the Customers page instead. See Suspending an organization for what a suspension does.

Path Parameters

string
required
The unique identifier of the organization

Request Body

string
required
active or suspended.
string
Optional reason, up to 500 characters, sent as reason in the org.suspended event. Ignored when reactivating: the reason is cleared.
No other fields are accepted: an unknown field returns 400 invalid_request. While suspended, inbound phone and web calls to the organization’s agents are refused, new outbound calls return 409 ORG_SUSPENDED and queued outbound calls are skipped, and SMS from its agents is refused. Billing is unchanged. A change of status fires the org.suspended or org.reactivated event. Sending the status the organization already has changes nothing: the current row is returned and no event is sent.

Response

id, status, suspended_at, suspended_by (the actor who made the change, kept after reactivating) and suspended_reason. Reactivating sets suspended_at and suspended_reason to null.

Error codes