Unassign Phone Number by String

Unassign a phone number from an assistant by phone number string.

POST /api/v1/assistants/{assistant_id}/phone-numbers/unassign-by-number

Unassign Phone Number By String

cURL

curl --request POST \
  --url https://api.example.com/api/v1/assistants/{assistant_id}/phone-numbers/unassign-by-number \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "<string>"
}
'

200

{
  "success": true,
  "message": "<string>",
  "data": null
}

This endpoint unassigns a phone number from an assistant, making it available again within your organization’s pool. The phone number is not deleted from your account, but it will no longer route calls to this assistant.

Path Parameters

• assistant_id (string, required): The unique identifier of the assistant from whom the phone number will be unassigned.

Request Body

• phone_number (string, required): The phone number to unassign, specified in E.164 format (e.g., [phone]).

Request

{
  "phone_number": "[phone]"
}

Response

A successful request will return the updated phone number object, where the assistant_id is now null.

Response

{
  "id": "pn_1a2b3c4d5e6f7g8h",
  "phone_number": "[phone]",
  "assistant_id": null,
  "organization_id": "org_67890",
  "created_at": "2023-10-26T11:00:00Z",
  "updated_at": "2023-10-28T15:00:00Z"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

assistant_id · integer · required

Body

application/json

Schema for unassigning a phone number from an assistant.

phone_number · string · required

Phone number to unassign

Response

200

application/json

Successful Response

Standard API response format.

success · boolean · required

message · string · required

data · unknown