Skip to main content
POST
Create Transfer Target

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Friendly name (e.g. 'Billing').

Required string length: 1 - 160
target
string
required

E.164 number, sip: URI, or LiveKit identity.

Required string length: 3 - 255
mode
string
default:warm

warm | cold

sip_trunk_id
string | null
sip_headers
Sip Headers · object | null
briefing_prompt
string | null
transfer_announcement
string | null
tags
string[] | null
enabled
boolean
default:true

Response

Successful Response

id
string
required
owner_id
string
required
name
string
required
target
string
required
mode
string
required
sip_trunk_id
string | null
required
sip_headers
Sip Headers · object | null
required
briefing_prompt
string | null
required
transfer_announcement
string | null
required
tags
string[] | null
required
enabled
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required