Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Headers

Idempotency-Key
string

Optional retry key for create-style operations. Reusing the same key with the same request returns the original result; reusing it with a different request returns 409.

Required string length: 1 - 255

Path Parameters

id
string
required

Agent id.

Minimum string length: 1

Body

application/json
targetLocationId
string
required
Minimum string length: 1
Example:

"loc_xyz789"

mode
enum<string>
required

What to copy. campaign duplicates the campaign and workflow onto a fresh default agent. everything also clones the voice agent. agent is the inverse of the other two: it carries the AGENT — its voice, its script and its own skills — onto a brand-new campaign of the type named in agentType, and copies nothing the source campaign started on.

Available options:
campaign,
everything,
agent
Example:

"everything"

name
string
required
Minimum string length: 1
Example:

"Roofing Follow Up Clone"

agentType
string

Required for mode agent, and refused on the other two, which copy the source campaign's own type and cannot retype it.

Example:

"inbound"

activeTags
string[]

Trigger tags for the clone, on a sub-account whose CRM has tags. A tag drives one campaign per sub-account, so a clone landing in the SAME sub-account as its source cannot inherit the source's tags — send its own here, or the copy arrives with no trigger and never dials. Omit when cloning into a different sub-account, where the inherited tags are still free. Ignored for mode agent, which mints its own campaign.

Minimum string length: 1
Example:
{key}
any

Response

Agent or campaign cloned.

success
boolean
required
mode
enum<string>
required
Available options:
campaign,
everything
campaignId
string
required
agentId
string
required
idempotentReplay
boolean

True when returned from a previous successful Idempotency-Key request.

agent
object
campaign
object
{key}
any