Copy an agent to a sub-account
Copy one of your agents, or a single task, into a sub-account. The copy is created paused and lists what to connect. Requires confirm: true.
master_workflow_idcopies an agent with all its tasks. In the API an agent is amaster_workflow.workflow_idcopies a single task. In the API a task is aworkflow.
What the copy includes
The copy keeps the configuration, stages, fields, tools, and rules of the source, and it is created paused, so it does not contact anyone yet. Connections bound to your main account are not copied: WhatsApp and phone numbers, channels, integrations, knowledge bases, offers, and hosts.next_steps and missing_connections list what the sub-account must connect. Steps with blocking: true stop the channels listed in blocks until they are done.
After connecting what is missing, set the tasks live from inside the sub-account.
A deactivated sub-account returns 409 sub_account_inactive. Reactivate it first with Reactivate sub-account.
For the feature gate, scopes, and confirm, see Before you start.Authorizations
API key for authentication. Keys are prefixed with nxr_live_.
Path Parameters
Sub-account ID, from items[].id in List sub-accounts. A malformed ID returns 400 invalid_sub_account_id.
Body
Response
status: "existed": the copy already existed; nothing new was created.
created, existed The copied agent in the sub-account. null when the source was a single task.
The copied tasks in the sub-account, all paused.
What the sub-account must set up before the copy goes live. blocking: true steps stop the channels listed in blocks.
Connections and credentials that were left out of the copy.