Reset an item in a queue

PUT 
/social-media-posting/category/queues/:queueId/items/:itemId/reset

Resets a specific queue item to its original state, discarding any modifications made.

Request

Version stringrequired

API Version

Available optionsv3

queueId stringrequired

Category queue ID

itemId stringrequired

Queue item ID

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID

sessionIdstring

Edit session ID

Example (auto)

{
  "locationId": "609e126a1c4ae1001291e1b5",
  "sessionId": "60af88475f1b2c001f5d5f4b"
}

application/json

The queue item has been successfully reset.

application/json

Schema

Schema

successbooleanrequired

Success or Failure

statusCodenumberrequired

Status Code

resultsobjectrequired

Response payload

traceIdstring

Trace ID for debugging

Example (auto)

{
  "success": true,
  "statusCode": 200,
  "results": {
    "message": "Queue item reset successfully",
    "queueItem": {
      "_id": "60af88475f1b2c001f5d5f4b",
      "order": 1000,
      "variations": [
        {
          "_id": "60af88475f1b2c001f5d5f4c",
          "content": "Check out our latest blog post! #marketing #socialmedia",
          "mentions": [
            {
              "platform": "instagram",
              "username": "example_user",
              "offset": 10,
              "length": 12
            }
          ],
          "ogTags": {
            "metaLink": "https://example.com",
            "metaImage": "https://example.com/image.png",
            "ogTitle": "Example Title"
          }
        }
      ],
      "primaryImage": "https://example.com/images/post-image.png",
      "postId": "60af88475f1b2c001f5d5f4d",
      "post": {
        "_id": "60af88475f1b2c001f5d5f4d",
        "summary": "Scheduled queue post",
        "media": [],
        "type": "post"
      },
      "errors": [],
      "scheduledDateTime": "2023-10-15T10:00:00.000Z",
      "scheduledVariationIndex": 0,
      "isSkipped": false,
      "currentVariation": 0
    }
  },
  "traceId": "TRACE-abc123-def456"
}