curl --request PATCH \
--url https://api.withallo.com/v2/api/dialing-queues/{queue_id}/assignee \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"user_id": "usr-15BB68317A7F06F0C07A3BBD8F244102A6872220"
}
'{
"data": {
"id": "<string>",
"name": "<string>",
"creator_id": "<string>",
"assignee_id": "<string>",
"voicemail_handling": "SKIP",
"do_not_disturb": "ENABLED",
"numbers": [
{
"number_to": "<string>",
"position": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"call_start_date": "2023-11-07T05:31:56Z",
"call_id": "<string>",
"routing_result": "FAILED",
"sync_status": "NOT_SYNCED",
"detected_outbound_voicemail": true,
"not_reached_destination_reason": "BUSY",
"voicemail_left": true,
"call_status": "QUEUED"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"type": "validation_error",
"code": "DIALING_QUEUE_ASSIGNEE_REQUIRED",
"message": "Provide 'user_id' or 'email' of the team member the dialing queue should be assigned to.",
"retryable": false,
"suggestion": "List your teammates with GET /v2/api/users and pass one of their ids as 'user_id'."
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "permission_error",
"code": "DIALING_QUEUE_ASSIGN_FORBIDDEN",
"message": "Only a team admin or manager can reassign a dialing queue.",
"retryable": false,
"suggestion": "Use an API key that belongs to a team admin or manager."
}
}{
"error": {
"type": "not_found_error",
"code": "DIALING_QUEUE_NOT_FOUND",
"message": "No dialing queue found for the requested id.",
"retryable": false,
"suggestion": "List queues with GET /v2/api/dialing-queues or create one with POST /v2/api/dialing-queues."
}
}{
"error": {
"type": "conflict_error",
"code": "DIALING_QUEUE_SESSION_ACTIVE",
"message": "The dialing queue has an open dialing session, so its assignee cannot change.",
"retryable": false,
"suggestion": "End the session in the Allo app, then retry the request."
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Power Dialer
Reassign queue
Reassigns a dialing queue to another member of the team. The queue keeps its numbers and its creator. Only API keys of a team admin or manager can call this endpoint, and the API key owner must be the queue’s creator or current assignee.
PATCH
/
v2
/
api
/
dialing-queues
/
{queue_id}
/
assignee
curl --request PATCH \
--url https://api.withallo.com/v2/api/dialing-queues/{queue_id}/assignee \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"user_id": "usr-15BB68317A7F06F0C07A3BBD8F244102A6872220"
}
'{
"data": {
"id": "<string>",
"name": "<string>",
"creator_id": "<string>",
"assignee_id": "<string>",
"voicemail_handling": "SKIP",
"do_not_disturb": "ENABLED",
"numbers": [
{
"number_to": "<string>",
"position": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"call_start_date": "2023-11-07T05:31:56Z",
"call_id": "<string>",
"routing_result": "FAILED",
"sync_status": "NOT_SYNCED",
"detected_outbound_voicemail": true,
"not_reached_destination_reason": "BUSY",
"voicemail_left": true,
"call_status": "QUEUED"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"type": "validation_error",
"code": "DIALING_QUEUE_ASSIGNEE_REQUIRED",
"message": "Provide 'user_id' or 'email' of the team member the dialing queue should be assigned to.",
"retryable": false,
"suggestion": "List your teammates with GET /v2/api/users and pass one of their ids as 'user_id'."
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "permission_error",
"code": "DIALING_QUEUE_ASSIGN_FORBIDDEN",
"message": "Only a team admin or manager can reassign a dialing queue.",
"retryable": false,
"suggestion": "Use an API key that belongs to a team admin or manager."
}
}{
"error": {
"type": "not_found_error",
"code": "DIALING_QUEUE_NOT_FOUND",
"message": "No dialing queue found for the requested id.",
"retryable": false,
"suggestion": "List queues with GET /v2/api/dialing-queues or create one with POST /v2/api/dialing-queues."
}
}{
"error": {
"type": "conflict_error",
"code": "DIALING_QUEUE_SESSION_ACTIVE",
"message": "The dialing queue has an open dialing session, so its assignee cannot change.",
"retryable": false,
"suggestion": "End the session in the Allo app, then retry the request."
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Required scope:
DIALING_QUEUE_READ_WRITEcreator_id; only assignee_id changes. The new assignee sees the queue in their Power Dialer right away.
Who can reassign
- The API key must belong to a team admin or manager. A member key gets
403 DIALING_QUEUE_ASSIGN_FORBIDDEN. - The API key owner must be the queue’s creator or current assignee. Otherwise the response is
404 DIALING_QUEUE_NOT_FOUND.
Choosing the new assignee
Senduser_id or email in the JSON body. One of them is required (400 DIALING_QUEUE_ASSIGNEE_REQUIRED).
user_id— wins when both are provided. Resolve teammate ids viaGET /v2/api/users.email— used only whenuser_idis absent.
404 ASSIGNEE_NOT_FOUND.
Open dialing sessions
A queue with an open dialing session can’t be reassigned (409 DIALING_QUEUE_SESSION_ACTIVE). End the session in the Allo app, then retry.Authorizations
Path Parameters
Id of the dialing queue.
Example:
"pdl-174AB37D545367EB5CE26784EE7A376202B2BFAE"
Body
application/json
The team member the queue should be assigned to. Provide user_id or email; user_id wins when both are provided.
Id of the new assignee. Resolve teammate ids via GET /v2/api/users.
Example:
"usr-15BB68317A7F06F0C07A3BBD8F244102A6872220"
Email of the new assignee. Used only when user_id is absent.
Example:
Response
Reassigned queue
A user's Power Dialer queue with its configuration and numbers.
Show child attributes
Show child attributes
Was this page helpful?