PostZen
Queues

Create a queue

POST
/v1/queue/slots

Creates a posting queue on a profile. A profile may hold up to 10 queues, each with up to 56 slots. The first queue on a profile automatically becomes its default. This endpoint requires a read-write API key.

Authorization

bearerAuth
AuthorizationBearer <token>

PostZen API key.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/queue/slots" \  -H "Content-Type: application/json" \  -d '{    "profileId": "k57a1p3q9w2y8b6d4f0g",    "name": "Morning Posts",    "timezone": "America/Edmonton",    "slots": [      {        "dayOfWeek": 1,        "time": "09:00"      },      {        "dayOfWeek": 3,        "time": "09:00"      }    ],    "active": true  }'
{  "success": true,  "schedule": {    "_id": "string",    "profileId": "string",    "name": "string",    "description": "string",    "timezone": "string",    "slots": [      {        "dayOfWeek": 0,        "time": "string"      }    ],    "active": true,    "isDefault": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "nextSlots": [    "2019-08-24T14:15:22Z"  ]}
{  "error": "JSON body is required"}
{  "error": "Unauthorized"}
{  "error": "API key requires read_write permission"}
{  "error": "Not found"}
{  "error": "string"}
{  "error": "rate_limited",  "retryAfter": 30}
{  "error": "Failed to create post"}

Get a queue schedule GET

Returns the queue selected by `queueId`, or the profile's default queue when `queueId` is omitted. With `all=true` every queue on the profile is returned instead. `nextSlots` holds the next five instants the queue would hand out, already skipping occupied slots; a paused or slotless queue returns an empty array.

Update a queue PUT

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.