Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

TFU Live agent id. Never use an ordinary provider agent id.

Query Parameters

locationId
string
required

Sub-account belonging to the authenticated agency and any narrower credential location binding.

campaignId
string

When more than one campaign uses this rep, the one whose calling line to use.

Pattern: ^[a-zA-Z0-9_-]{1,100}$

Body

application/json

{ number }: one of the attachable numbers.

number
string
required

One of the attachable numbers.

Pattern: ^\+[1-9]\d{7,14}$
Example:

"+14155550123"

Response

Successful response.

success
any
required
number
string
required
line
object | null
required

The rep’s calling line as it is now.

inbound
boolean
required
unchanged
boolean
required

The number was already the rep’s: nothing changed.