Skip to navigation
API Referencenumbers

Update Number

Update a number. Only the fields you send are changed.

externalId: your own identifier for the number. Send a string to set it, null to clear it, or omit it to leave it unchanged. 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>.

Fields this endpoint does not support are rejected with 422, never silently ignored.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

number_idstringRequired

Request

This endpoint expects an object.
externalIdstring or nullOptional

Response

Successful Response
idstring
phoneNumberstring
countrystring
statusstring
createdAtdatetime
typestringOptionalDefaults to sms
agentIdstring or nullOptional
outboundSmsenumOptionalDefaults to enabled
Allowed values:
inboundCallsEnabledbooleanOptionalDefaults to true
readReceiptsEnabledbooleanOptionalDefaults to true
whatsappEnabledbooleanOptionalDefaults to false
dailyNewContactsobject or nullOptional
externalIdstring or nullOptional
purchasedAtdatetime or nullOptional

Errors

422
Unprocessable Entity Error