Skip to main content
PATCH
An empty body clears the number’s agent, the same as {"agent_id": null}. Calls to a number with no agent go to the trunk’s default_inbound_agent_id, and are refused when that is not set either.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
number_id
string<uuid>
required

The number's id

Body

application/json
​
agent_id
string | null

Agent that answers inbound calls to this number. null, or leaving the field out, clears the assignment.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

The updated number

​
id
string<uuid>
Example:

"5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9"

​
trunk_id
string<uuid>
Example:

"3f2b8c1e-6d4a-4f7b-9e2c-1a5d7b9c0e21"

​
e164
string
Example:

"+12025550143"

​
destination_key
string
Example:

"12025550143"

​
agent_id
string | null

Agent that answers inbound calls to this number. When null, the trunk's default_inbound_agent_id answers.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
last_inbound_at
string<date-time> | null

When this number last took an inbound call, updated at most once a minute.

​
last_outbound_at
string<date-time> | null

When an outbound call was last placed from this number, updated at most once a minute.

​
created_at
string<date-time>
​
updated_at
string<date-time>
​
is_deleted
boolean
​
deleted_at
string<date-time> | null