WayloAIWaylo Docs
APIReferencePhone numbers

Update phone number

PATCH
/phone-numbers/{id}

Rename it, assign or unassign its agent (agentId: null), or retire and restore it with active. Retiring detaches it at the carrier, where it falls back to its own routing; restoring re-proves ownership and attaches it again.

Access: workspace_admin · API key phone_numbers:write

Authorization

api-key
headerAuthorizationBearer <sk_waylo_<lookup><secret><checksum>>

Path Parameters

id*string

Header Parameters

Authorization*string

Your API key.

Request Body

application/json
  1. body
name?|
Length1 <= length <= 100
agentId?|
Formatuuid
active?boolean

Response Body

Updated

application/json
  1. response
id*string
workspaceId*string
connectionId*string
connectionName*string
provider*"twilio"
Value in"twilio"
e164*string
providerNumberId*string
name*string|null
agentId*|
Formatuuid
agentName*string|null
status*string
Value in"activating""active""failed"
statusReason*string|null
active*boolean
createdByUserId*|
Formatuuid
createdByUserName*string|null
updatedByUserId*|
Formatuuid
updatedByUserName*string|null
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X PATCH 'https://api.poc.app.waylovoice.ai/phone-numbers/string' \  -H 'Authorization: Bearer sk_waylo_...' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "workspaceId": "string",  "connectionId": "string",  "connectionName": "string",  "provider": "twilio",  "e164": "string",  "providerNumberId": "string",  "name": "string",  "agentId": "bc309ecf-5f66-4057-93c5-6611cc9cb7b2",  "agentName": "string",  "status": "activating",  "statusReason": "string",  "active": true,  "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",  "createdByUserName": "string",  "updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",  "updatedByUserName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}