Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-136188852.7 MB

9cd7291d4228

communication

Update a phone number

patch/v1/communication/phone-numbers/{phone_number_id}

Path parameters

phone_number_idstring uuid required

Request body

status'active' | 'paused' | 'retired'
capabilitiesPhoneCapability[] nullable
vendor_metadataobject nullable

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
retired_atstring date-time nullable
retired_bystring nullable
restored_atstring date-time nullable
restored_bystring nullable
created_atstring date-time required
updated_atstring date-time required