Skip to main content
DELETE
/
v2
/
api
/
dialing-queues
/
current
/
numbers
Clear queue numbers
curl --request DELETE \
  --url https://api.withallo.com/v2/api/dialing-queues/current/numbers \
  --header 'Authorization: <api-key>'
{
  "data": {
    "removed": 4
  }
}

Targeting a teammate’s queue

By default, this clears numbers from the queue assigned to the API key owner. To clear a teammate’s queue, pass user_id or email as a query parameter. 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

Query Parameters

number
string

Phone number to remove (any format — normalized to E.164). Removes every entry matching this number unless position is also supplied.

Example:

"+12125550010"

position
integer

0-based position to remove. Combine with number to disambiguate when the same number appears more than once.

Required range: x >= 0
Example:

3

unassigned
boolean

When true, removes every queue entry that has not been called yet. Cannot be combined with number or position.

Example:

true

user_id
string

ID of a teammate whose queue to clear. Resolve teammate ids via GET /v2/api/users. Wins over email when both are provided.

Example:

"usr-15BB68317A7F06F0C07A3BBD8F244102A6872220"

email
string<email>

Email of a teammate whose queue to clear. Ignored when user_id is also supplied.

Response

Numbers removed

data
object

Result of clearing numbers from a Power Dialer queue.