Sign in

v51

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

Update a number's metadata.

Updates configuration flags for a number. Requires CustomerAdmin or CustomerManager permission. The response returns the full number object including the updated metadata.

put/numbers/{id}/metadata

Path parameters

idstring required

The unique identifier of the number (UUID). Obtained from the id field of GET /numbers.

Request body

rtp_debugboolean

When set to true, RTPEngine captures RTP traffic as PCAP files for calls to this number. This flag is OR'd with the customer-level rtp_debug — if either is true, capture is enabled. Use this to debug audio quality issues on a specific number without enabling capture for all customer calls. Default is false. Enabling this increases storage usage — disable after debugging.

Response

The updated number object with the new metadata applied.

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"
}