Update queue settings or status

PUT 
/social-media-posting/category/queues/:queueId

Updates queue status (active/paused/deleted), time slots, or skip dates.

Request

Version stringrequired

API Version

Available optionsv3

queueId stringrequired

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID

skipLegacyWatermarkboolean

Skip legacy watermark cleanup when rescheduling posts

statusobject

Status of the Queue

skipDateTimestring

Skip Date Time in ISO format

timeSlotsobject[]
enableFuturePostsboolean

Enable posting future content. Automatically Queue any New Posts Created in this Category.

prioritizeNewContentboolean

Prioritize new content over older content. When true, new items added via directToQueue will be placed at the top of the queue.

Example (auto)

{
  "locationId": "609e126a1c4ae1001291e1b5",
  "skipLegacyWatermark": false,
  "status": "paused",
  "skipDateTime": "2023-10-05T14:48:00.000Z",
  "timeSlots": [
    {
      "dayOfWeek": 0,
      "time": "09:00"
    }
  ],
  "enableFuturePosts": true,
  "prioritizeNewContent": false
}

application/json

Queue updated successfully.

application/json

Schema

Schema

successbooleanrequired
statusCodenumberrequired
resultsobjectrequired
traceIdstring

Example (auto)

{
  "success": true,
  "statusCode": 200,
  "results": {
    "message": "Queue paused successfully.",
    "queue": {
      "_id": "60af88475f1b2c001f5d5f4b",
      "locationId": "location-123",
      "categoryId": "60af88475f1b2c001f5d5f4b",
      "timeSlots": [
        {
          "dayOfWeek": 0,
          "time": "09:00"
        }
      ],
      "enableFuturePosts": false,
      "prioritizeNewContent": false,
      "currentOrder": 1000,
      "status": "active",
      "startDate": "2023-01-01T12:00:00Z",
      "skipDateTime": [
        "2023-01-02T12:00:00Z"
      ],
      "currentPostId": "60af88475f1b2c001f5d5f4b",
      "totalPosts": 10,
      "lastScheduledTime": "2023-01-01T12:00:00Z",
      "createdBy": "user-123",
      "createdAt": "2023-01-01T00:00:00Z",
      "updatedAt": "2023-01-01T00:00:00Z"
    }
  },
  "traceId": "string"
}