Required scope
All endpoints require theDIALING_QUEUE_READ_WRITE scope on your API key.
Assigning a queue to a teammate
Every endpoint acceptsuser_id or email to act on a teammate’s queue instead of the API key owner’s. The wire location depends on the endpoint (query string vs JSON body) — see each endpoint’s “Targeting a teammate’s queue” section for specifics.
Rules that apply to every endpoint:
user_idwins when bothuser_idandemailare provided.- The teammate must belong to the same team as the API key owner.
- If the resolved user doesn’t exist or isn’t a teammate, the API returns
404 ASSIGNEE_NOT_FOUND. The same error covers both cases on purpose, so API consumers cannot enumerate users. - When you append to a teammate who has no current queue, one is created with the API key owner as
creator_idand the teammate asassignee_id.
Endpoints
Get current queue
Retrieve the queue assigned to a user (yourself or a teammate)
Upsert queue config
Update the queue name, voicemail handling, or do-not-disturb
Append numbers
Add phone numbers (and optional contact metadata) to a queue
Clear numbers
Remove specific numbers, a position, or every unassigned entry
Reset queue
Discard the current queue and start a fresh one