Sign in
iMessage

Claim Number

post/api/v1/imessage/numbers

Headers

Idempotency-Keystring required

Unique key used to replay this claim without allocating twice.

Unique key used to replay this claim without allocating twice.

Request body

ClaimIMessageNumberRequest required

Response

Successful Response

idstring uuid required
numberstring required
type'dedicated_outbound' required
status'active' | 'paused' required
inbound_onlyfalse

Deprecated compatibility field; dedicated lines can initiate.

agent_identity_idstring uuid nullable required
agent_handlestring nullable required

Changes