Clear queue numbers
Changed onRemoves numbers from the queue assigned to the authenticated user. Exactly one filter must be supplied via query string: number (E.164), position (0-based index), number + position together (delete a specific occurrence of a duplicate), or unassigned=true (remove every entry that has not been called yet). Combining unassigned with number or position is rejected. Pass user_id or email to clear a teammate's queue instead — user_id wins when both are provided.
Request
- Base URLhttps://api.withallo.com
- URLhttps://api.withallo.com/v2/api/dialing-queues/current/numbers
- AuthAPI key in header Authorization
Query parameters
Phone number to remove (any format — normalized to E.164). Removes every entry matching this number unless position is also supplied.
0-based position to remove. Combine with number to disambiguate when the same number appears more than once.
When true, removes every queue entry that has not been called yet. Cannot be combined with number or position.
ID of a teammate whose queue to clear. Resolve teammate ids via GET /v2/api/users. Wins over email when both are provided.
Email of a teammate whose queue to clear. Ignored when user_id is also supplied.
Response
Numbers removed
Example response
{
"data": {
"removed": 4
}
}Changes
- breaking
the response's body type changed from no type to
objectfor status - breaking
the response's body type changed from no type to
objectfor status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- breaking