Sign in
numbers

Update Number

Tag a number with your own identifier.

Send null to clear it. externalId must be unique within your account (409 otherwise). Works on any number type. The tag is echoed on every number response and webhook payload and usable for lookup as GET /v1/numbers/ext:<externalId> or GET /v1/numbers?externalId=<externalId>.

patch/v1/numbers/{number_id}

Path parameters

number_idstring required

Request body

externalIdstring nullable required

Response

Successful Response

idstring required
phoneNumberstring required
countrystring required
statusstring required
typestring
agentIdstring nullable
outboundSms'enabled' | 'activating' | 'registration_required'
inboundCallsEnabledboolean
readReceiptsEnabledboolean
whatsappEnabledboolean
externalIdstring nullable
createdAtstring date-time required
purchasedAtstring date-time nullable

Changes

Changed in 1 of the 26 revisions of this API.1