Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Number

Update order number by ID

Update the order number's details with the provided information.

put/numbers/{id}

Path parameters

idstring required

The ID of the order number to update.

Request body

call_flow_idstring required

The ID of the updated call flow.

message_flow_idstring required

The ID of the updated message flow.

namestring required

The updated name of the number.

detailstring required

Updated details for the number.

Response

The updated order number details.

idstring uuid

The unique identifier for the number.

customer_idstring uuid

The customer ID associated with the number. Returned from the GET /customers response.

numberstring

The phone number in E.164 format (normal) or +899 format (virtual).

type'normal' | 'virtual'

The type of the number.

call_flow_idstring uuid

The unique identifier of the flow to execute for incoming calls. Returned from the POST /flows or GET /flows response.

message_flow_idstring uuid

The unique identifier of the flow to execute for incoming messages. Returned from the POST /flows or GET /flows response.

namestring

The name of the number.

detailstring

Additional details about the number.

status'active' | 'deleted'

The status of the number.

t38_enabledboolean

Whether T38 is enabled for the number.

emergency_enabledboolean

Whether emergency services are enabled for the number.

tm_purchasestring date-time

The timestamp of when the number was purchased.

tm_renewstring date-time

The timestamp of when the number was renewed.

tm_createstring date-time

The timestamp of when the number was created.

tm_updatestring date-time

The timestamp of when the number was last updated.

tm_deletestring date-time

The timestamp of when the number was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "number": "+14155551234",
  "type": "normal",
  "call_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "message_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "name": "Main Support Line",
  "detail": "Primary inbound number for customer support",
  "status": "active",
  "tm_purchase": "2026-01-15T09:30:00.000000Z",
  "tm_renew": "2026-01-15T09:30:00.000000Z",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}