Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

number
string
required

E.164 phone number. URL-encode the leading + when placing it in the path.

Pattern: ^\+\d{10,15}$
campaignId
string
required

Campaign id.

Minimum string length: 1

Body

application/json

Destination campaign.

toCampaignId
string
required

Destination campaign id.

Example:

"campaign_speed_to_lead_456"

answerCalls
string[]

Numbers whose incoming calls this campaign takes over. A number nobody answers is taken without being listed. Other numbers keep their answering campaign. Each listed number must be on the campaign after this call. The campaign must be able to answer calls.

Maximum array length: 100
Pattern: ^\+\d{10,15}$
Example:

Response

Phone number moved.

success
boolean
required
phoneNumber
string
required
Pattern: ^\+\d{10,15}$
Example:

"+14155551234"

fromCampaignId
string
required
Example:

"campaign_speed_to_lead_123"

toCampaignId
string
required
Example:

"campaign_speed_to_lead_456"

moved
boolean
required
Example:

true

answerInboundUnconfirmed
string[]

Sent only when some are: TFU Live numbers whose incoming calls did not confirm they follow the next campaign that answers them. The change stands, and the platform keeps trying. Check those numbers in Phone Numbers.

Pattern: ^\+\d{10,15}$
Example: