Update a phone number

Update the agent assignment, transfer trunk or attached workflow for a phone number.

Authorization

BearerAuth

AuthorizationBearer <token>

API key authentication. Get your key from the dashboard.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

agent_id?|

Agent ID to assign (null to unassign)

Formatuuid

transfer_trunk_id?|

SIP trunk ID for transfers (null to remove)

Formatuuid

workflow_id?|

Workflow that drives calls to this number (null to detach). The workflow must belong to your organization. While attached, the workflow supplies the conversation structure; the assigned assistant keeps supplying the voice, models and call settings.

Formatuuid

is_active?boolean

Whether the number is active

Response Body

`application/json`

curl -X PATCH "https://example.com/numbers/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{
  "number": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "phone_number": "+31850835037",
    "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
    "transfer_trunk_id": "ffebe614-a59e-4332-b99b-9c8f0b1671f9",
    "workflow_id": "03e70e31-d7a4-4401-a629-6a4b6096cdfe",
    "source": "user",
    "is_active": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "Invalid API key",
  "message": "string"
}

{
  "error": "Invalid API key",
  "message": "string"
}

{
  "error": "Invalid API key",
  "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`