Skip to main content
POST
Create an embed token

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key
string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Body

application/json
customer_id
string
required
component
enum<string>
required
Available options:
connection,
inbox,
messages,
templates,
usage
expires_in_minutes
integer
Required range: 5 <= x <= 10080
origin_allowlist
string<uri>[]
phone_number_id
string

Scope the component to one number.

Maximum string length: 64
locale
string
Maximum string length: 16

Response

Created.

id
string
component
enum<string>
Available options:
connection,
inbox,
messages,
templates,
usage
url
string

Load this in an iframe.

token
string

Short-lived, single component, single customer.

expires_at
string<date-time> | null