Skip to main content
POST
Pause sub-account
Pausing stops every agent of the sub-account from writing and calling. The sub-account’s team keeps access and can set tasks live again one by one. paused_workflow_ids lists the tasks this call paused. If failed_workflow_ids is not empty, those tasks are still live: call the endpoint again to retry them. To also hide the sub-account from its team, use Deactivate 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

Pause result.

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.

Last modified on October 1, 2026