Skip to content

Reorder a call in the queue

POST
/v1/calls/{call}/reorder
curl --request POST \
--url https://api.caller9.app/v1/calls/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/reorder \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "dir": -1 }'

Changes a main-queue call’s position. Send either dir (swap with the adjacent call above/below) or beforeGuid (move in front of that call, or null to move to the end). Moving past the top/bottom edge, or dropping a call on itself, is a no-op. Hotline calls cannot be reordered. The new order is shared by every operator viewing the studio.

call
required
string format: uuid

Call ID (UUID).

Media typeapplication/json
One of:
object
dir
required

-1 moves the call up one place, 1 moves it down one place.

integer
Allowed values: 1 -1

Examples

{
"dir": -1
}

Action accepted.

Media typeapplication/json
object
ok
required
boolean

Example

{
"ok": true
}

only queued calls can be reordered (hotline call), target call not found (beforeGuid not in the queue), or dir (1 | -1) or beforeGuid (guid | null) is required.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Missing, invalid, expired or revoked API key.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

The key isn’t allowed to do this (e.g. a read-only key making a change).

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

call not found — the call doesn’t exist, belongs to another organization, or has already ended (or, for reorder, call not found in queue).

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Too many requests for this API key. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}
Retry-After
integer

Seconds until the rate-limit window resets.