Queues

Update a queue

Replaces a queue's timezone and slots, and optionally renames, pauses, or promotes it to default. With reshuffleExisting: true the queue's future scheduled posts are re-placed onto the new schedule in their existing order; posts that are already publishing, published, or failed are never moved, and at most 200 posts may move in one call. Validation and slot assignment both run before the first write, so a rejected update leaves the queue untouched. This endpoint requires a read-write API key.

put/v1/queue/slots

Request

  • Base URL: https://api.postzen.dev
  • URL: https://api.postzen.dev/v1/queue/slots
  • Auth: HTTP bearer

Request body

profileIdstring required

Profile that owns the queue.

queueIdstring

Queue to update. Defaults to the profile's default queue.

namestring
descriptionstring

Send an empty string to clear the description.

timezonestring required
activeboolean
setAsDefaultboolean
reshuffleExistingboolean

Re-place the queue's future scheduled posts onto the new schedule. Only applies when the timezone or slots actually changed.

Response

Queue updated.

successboolean required
nextSlotsstring[] required
reshuffledCountinteger required

How many scheduled posts were moved onto the new schedule.

Changes

No recorded changes to this operation across all 1 revision of this API.