Skip to main content
POST
Deactivate sub-account
Deactivating pauses every agent of the sub-account and then hides the account from its team. No data is deleted. If any task cannot be paused, the sub-account is not deactivated: the call returns 502 pause_incomplete with paused_workflow_ids and failed_workflow_ids. Call it again. There is no delete. To restore access later, use Reactivate sub-account. For the feature gate, scopes, and confirm, see Before you start.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

sub_account_id
string<uuid>
required

Sub-account ID, from items[].id in List sub-accounts. A malformed ID returns 400 invalid_sub_account_id.

Body

application/json
confirm
enum<boolean>
required

Must be true.

Available options:
true

Response

Sub-account deactivated.

paused_workflow_ids
string<uuid>[]
required

Tasks (workflow in the API) this call paused.

failed_workflow_ids
string<uuid>[]
required

Tasks that could not be paused.

deactivated_at
string<date-time>
required
Last modified on October 1, 2026