numbers

Update a phone number

Rename a number or change its agent assignments. An incoming-call assignment pins the current publication; reassign after changing the live version.

Enable inbound on the Twilio trunk and configure its returned inbound_sip_uri in Twilio Origination first.

Setting inbound_agent_id pins the agent’s current publication and the assigning admin’s live authority to the number. Each signed SIP arrival admits an inbound run. Set the field to null to remove the assignment; reassign after publishing or promoting a new version.

patch/api/v1/telephony/numbers/{number_id}

Request

  • Base URL: https://api.cumuluslabs.io
  • URL: https://api.cumuluslabs.io/api/v1/telephony/numbers/{number_id}
  • Auth: HTTP bearer

Path parameters

number_idstring uuid required

Request body

trunk_idstring
nicknamestring nullable
inbound_agent_idstring nullable
outbound_agent_idstring nullable

Response

Assign agents or rename a phone number

number_idstring uuid required
e164string required
trunk_idstring required
nicknamestring nullable required
inbound_agent_idstring nullable required
outbound_agent_idstring nullable required
inbound_agent_versioninteger nullable required

Stored inbound publication pin, including legacy version 0; null when unassigned. Publishing a newer head does not change it.

outbound_agent_versioninteger nullable required

Stored outbound publication version; null when unassigned.

state'pending' | 'ready' required
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.