Skip to main content
POST
Send exactly one source:
  • master_workflow_id copies an agent with all its tasks. In the API an agent is a master_workflow.
  • workflow_id copies a single task. In the API a task is a workflow.

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

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
source
object
required

What to copy. Send exactly one of the two IDs.

confirm
enum<boolean>
required

Must be true.

Available options:
true
names
object

Optional new names for the copy. principal sets the name of the copied agent. Leave it out to keep the source names.

Response

status: "existed": the copy already existed; nothing new was created.

status
enum<string>
required
Available options:
created,
existed
master_workflow_id
string<uuid> | null
required

The copied agent in the sub-account. null when the source was a single task.

workflow_ids
string<uuid>[]
required

The copied tasks in the sub-account, all paused.

next_steps
object[]
required

What the sub-account must set up before the copy goes live. blocking: true steps stop the channels listed in blocks.

missing_connections
object[]
required

Connections and credentials that were left out of the copy.

Last modified on October 1, 2026