v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-304917042.1 MB

communication

Register an org phone number

post/v1/communication/phone-numbers

Request body

phone_e164string required

vendor'twilio' required

vendor_mode'platform' | 'byo' required

capabilitiesPhoneCapability[]

vendor_metadataobject

integration_connection_idstring uuid nullable

BYOT only. Pin the new Sender to a specific connected Twilio integration. Required when the org has more than one connected Twilio integration; when omitted, the service auto-discovers the org's single connected integration and 422s on ambiguity.

Response

Successful Response

idstring uuid required

organization_idstring uuid required

phone_e164string required

vendor'twilio' required

vendor_mode'platform' | 'byo' required

capabilitiesPhoneCapability[] required

vendor_metadataobject required

status'active' | 'paused' | 'retired' required

created_atstring date-time required

updated_atstring date-time required