Agents

Detach Agent Phone Number

Unlinks a phone number from an agent for one direction. Live calls block either direction. Unfinished batches and active workflows using the number additionally block outbound detachment.

delete/v1/agents/{agentId}/phone-numbers/{phoneNumberId}

Request

  • Base URL: https://api.dialnexa.com
  • URL: https://api.dialnexa.com/v1/agents/{agentId}/phone-numbers/{phoneNumberId}
  • Auth: HTTP bearer

Path parameters

agentIdstring required
Example:agent_2g7Xy3tY53gRlp

Agent ID from List Agents.

phoneNumberIdstring required
Example:phn_2g7Xy3tY53gRlp

Phone number ID from List Agent Phone Numbers.

Query parameters

direction'inbound' | 'outbound' required

The direction to detach. A number linked for both directions keeps the other one.

Response

Successful response.

successboolean required
errorboolean required
statusCodeinteger required
messagestring required
timestampstring date-time required

Example response

{
  "data": {
    "agent_id": "agent_2g7Xy3tY53gRlp",
    "phone_number_id": "phn_abc123"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.