Skip to main content
PUT
Reorder message queue

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Scopes

full_access
PersonalAccessTokenAuth
full_access
WorkspaceApiKeyAuth
full_access
WorkspaceApiKeyBearerAuth

Path Parameters

app_id
string
required

ID of the app whose message queue this request acts on.

Query Parameters

branch_id
string

ID of the branch to work on, as returned by List branches. Omit it to work on the app's main branch.

Body

application/json
item_ids
string[]
required

IDs of queued messages in the order you want them to run. IDs not in the queue are ignored, and queued messages you leave out keep their order after the ones you list. Each ID can appear once.

Example:

Response

The queue in its new order.

The messages waiting to run, in the order they run.

items
QueuedMessage · object[]
required

The queued messages, next to run first. Holds at most 7 independent requests; an internal session continuation does not use a slot.

Example:
is_paused
boolean
required

Whether the queue is paused. While it is, queued messages don't run.

Example:

false

session_id
string | null

Present only on enrolled Base Code apps: the session owning this queue.

Example:

"68f1a2b3c4d5e6f708192a4"