Skip to main content
Category QueueVersion: v3

Create a new item in the queue

POST/social-media-posting/category/queues/{queueId}/create/item

Adds a new post item to a queue. Use sessionId for edit session or directToQueue for immediate addition.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:socialplanner/category.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

queueIdstringrequired

Category queue ID

Example:507f1f77bcf86cd799439011

Body

locationIdstringrequired

Location ID

Example:609e126a1c4ae1001291e1b5
sessionIdstring

Edit session ID

Example:60af88475f1b2c001f5d5f4b
modifiedPostPayloadobject

New post details

Example
{
  "summary": "New queued post content",
  "media": []
}
orderobject

Order for the new item in the queue (cyclic-aware). Accepts:

  • A number: explicit order value calculated by FE as midpoint between adjacent items
  • "top": place at cyclic top (first to be scheduled next)
  • "bottom": place at cyclic bottom (last to be scheduled)

For positions between items, FE calculates: Math.floor((prevItem.order + nextItem.order) / 2) Defaults to end if not provided. Note: This field is ignored when directToQueue is true - the order will be automatically calculated based on the queue's prioritizeNewContent setting.

Example:top
variationsobject[]

Variations

Example
[
  {
    "content": "Try this variation",
    "mentions": [],
    "ogTags": {
      "metaLink": "https://example.com"
    }
  }
]
primaryImagestring

Primary media URL (image) for the post. Falls back to modifiedPostPayload.primaryImage if not set.

Example:http://example.com/media.png
directToQueueboolean

When true, creates the queue item directly without requiring an edit session, even for active/paused queues. The order field is ignored and the item position is determined by the queue's prioritizeNewContent setting: if true, the item is added to the top of the queue; if false, it is added to the bottom.

Example:false

Response

Queue item created successfully.

successbooleanrequired

Success or Failure

Example:true
statusCodenumberrequired

Status Code

Example:201
resultsobjectrequired

Response payload

traceIdstring

Trace ID for debugging

Example:TRACE-abc123-def456