Upsert current queue

curl --request PATCH \
  --url https://api.withallo.com/v2/api/dialing-queues/current \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Cold Calls"
}
'

{
  "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
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "ASSIGNEE_NOT_FOUND",
    "message": "No team member found for the provided 'user_id' or 'email'.",
    "retryable": false,
    "suggestion": "List your teammates with GET /v2/api/users and use one of their ids as 'user_id', or pass a team-member email."
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

PATCH

api

dialing-queues

current

curl --request PATCH \
  --url https://api.withallo.com/v2/api/dialing-queues/current \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Cold Calls"
}
'

{
  "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
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "ASSIGNEE_NOT_FOUND",
    "message": "No team member found for the provided 'user_id' or 'email'.",
    "retryable": false,
    "suggestion": "List your teammates with GET /v2/api/users and use one of their ids as 'user_id', or pass a team-member email."
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

Targeting a teammate’s queue

By default, this updates the config of the queue assigned to the API key owner. To update a teammate’s queue, send user_id or email in the JSON body. The teammate must belong to the same team as the API key owner.

user_id — wins when both are provided. Resolve teammate ids via GET /v2/api/users.
email — used only when user_id is absent.

If the resolved user isn’t on your team, the response is 404 ASSIGNEE_NOT_FOUND.

Authorizations

Authorization

string

header

required

Body

application/json

Creates or updates the queue config. All fields are optional — only the fields you supply are touched. Pass user_id or email to act on a teammate's queue instead.

name

string | null

New queue name (1–255 characters)

Required string length: 1 - 255

voicemail_handling

enum<string> | null

How the Power Dialer reacts when the call hits voicemail.

Available options:

SKIP,

NO_SKIP

do_not_disturb

enum<string> | null

Silence inbound calls while running the queue.

Available options:

ENABLED,

DISABLED

user_id

string | null

Optional. ID of a teammate whose queue config should be updated. The teammate must belong to the same team as the API key owner. Wins over email when both are provided.

Example:

"usr-15BB68317A7F06F0C07A3BBD8F244102A6872220"

string<email> | null

Optional. Email of a teammate whose queue config should be updated. Ignored when user_id is also supplied.

Example:

"[email protected]"

Response

Updated queue

data

object

A user's Power Dialer queue with its configuration and numbers.

Show child attributes

API

Webhooks

Conversations

CRM

People

Companies

Deals

Notes

Threads

Phone Numbers

AI Receptionist

Tags

Summary Templates

Users

SMS

Analytics

Power Dialer

Partner

Targeting a teammate’s queue

Authorizations

Body

Response

​Targeting a teammate’s queue

Authorizations

Body

Response

Targeting a teammate’s queue