Update a phone number

Change a phone number's label, route target, or variables. Only the fields you send are modified — omit a field to leave it as it is, and send an explicit null to clear it. Clearing the target unroutes the number, so inbound calls to it are no longer answered. The number itself cannot be changed after purchase; a request that includes phoneNumber is rejected.

Authorization

bearerAuth

AuthorizationBearer <token>

A Tandem bearer token. Requests are scoped to the organization the token belongs to; no organization header is required.

In: header

Path Parameters

phoneNumberId*string

The phone number's unique ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Every field is optional. An omitted field is left unchanged. A null clears the field — note that label is not nullable, because a phone number must always have one.

label?string

Length1 <= length <= 200

workflowId?|

Deprecated. Set target instead; a workflow target is mirrored into this field automatically. Still accepted for older integrations.

target?||

The new route. Null unroutes the number, so inbound calls are no longer answered.

variables?|

Replaces the number's variables. Null removes all of them. At most 50 variables, with names up to 128 characters and values up to 2,000 characters. All names and values together may not exceed 64 KB (UTF-8 bytes). A request over a limit is rejected with a 400.

Propertiesproperties <= 50

recordCalls?RecordingOverride

Whether calls on this number are recorded. inherit follows the organization's default; always and never override it. Absent on a number that has never set one, which behaves as inherit.

Value in

"inherit"
"always"
"never"

Response Body

`application/json`

curl -X PUT "https://example.com/v1/routing/phone-numbers/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "label": "string",  "phoneNumber": "string",  "workflowId": "string",  "target": {    "type": "workflow",    "id": "string"  },  "variables": {    "property1": "string",    "property2": "string"  },  "recordCalls": "inherit",  "smsCapability": "enabled",  "mmsCapability": "enabled",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

Update a phone number

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`