Add a new transfer number to an agent

POST

/agents/{id}/transfer-numbers

Creates a routing option the agent can forward calls to. Label must be lowercase letters only and unique per agent. Phone in E.164 format, restricted to supported countries. Work hours use HHMM format per weekday; omit for 24/7. Hard limit of 20 transfer numbers per agent.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Transfer number created successfully

Bodyapplication/json

🟠400

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location '/agents//transfer-numbers' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "label": "sales",
    "description": "Use for sales inquiries and new customer questions",
    "phoneNumber": "+1234567890",
    "workHours": {
        "MONDAY": [
            900,
            1730
        ],
        "TUESDAY": [
            900,
            1730
        ]
    },
    "transferType": "warm",
    "isActive": true
}'

Response Example

{
    "id": "string",
    "label": "string",
    "description": "string",
    "phoneNumber": "string",
    "workHours": {},
    "transferType": "warm",
    "isActive": true,
    "sortOrder": 0,
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-07-23 18:02:16

Get all transfer numbers for an agent

Update a transfer number