Skip to main content
DELETE
Clear 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.

Path Parameters

app_id
string
required

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

Query Parameters

keep_pr_watch
string
default:false

true keeps queued PR Watch runs. If any remain, the queue keeps its pause.

keep_sent
string
default:false

true keeps messages already sent into the chat, which still run, and never refuses the clear with a 409. The response can then include them.

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.

Response

The emptied, unpaused queue. With keep_pr_watch=true, any kept PR Watch runs remain and the queue keeps its pause. With keep_sent=true, messages already sent into the chat remain too.

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.

Example:
is_paused
boolean
required

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

Example:

false