Reorder message queue

Changed on

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Changes the order queued messages run in. Pass the IDs in the new order.

A message that joined the queue after you read it, and so isn't in your list, keeps its place after the ones you list.

This is limited to 60 requests per minute per app for each workspace's personal API keys, so every key in a workspace shares one allowance. Every endpoint that changes the queue shares it. Some workspaces have a different limit.

<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>

<Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time.</Warning>

put/api/apps/{app_id}/chat/queue/reorder

Request

  • Base URL: https://app.base44.com
  • URL: https://app.base44.com/api/apps/{app_id}/chat/queue/reorder
  • Auth: HTTP bearer

Path parameters

app_idstring required

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

Query parameters

branch_idstring

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

Request body

item_idsstring[] 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 request

{
  "item_ids": [
    "3b9d2f6e-8c41-4a7e-9f05-1d2c3b4a5e6f",
    "9a1c4e2b-6d3f-4b8a-a7e1-2f5c8d0b3e4a"
  ]
}

Response

The queue in its new order.

is_pausedboolean required

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

Example response

{
  "items": [
    {
      "branch_id": "68f1a2b3c4d5e6f708192a3b",
      "content": "Add a contact form to the home page",
      "created_at": "2026-10-05T14:30:00.123456+00:00",
      "id": "3b9d2f6e-8c41-4a7e-9f05-1d2c3b4a5e6f"
    }
  ]
}

Changes

    • breaking

      query request parameter branch_id list-of-types was narrowed by removing types null

    • info

      for the query request parameter branch_id, the type was generalized from no type to string

    • info

      added the new optional query request parameter branch_id