HighLevel: Update an item in a queue

← Social planner operations · Get started

Operation gohighlevel.updatequeueitem

Provider route: PUT /social-media-posting/category/queues/{queueId}/items/{itemId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["socialPlanner"]["updateQueueItem"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.socialPlanner.updateQueueItem(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.social_planner.update_queue_item(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.queueId	string	Required within parent
path.itemId	string	Required within parent
body	Model	Required within parent	Expand Update an item in a queue — request body — body

Referenced models: Update an item in a queue — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Update an item in a queue — response body

Referenced models: Update an item in a queue — response body

Schemas

37 more schemas are linked from the tables above, on the schema pages.

Update an item in a queue — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	Model	Required within parent	Expand Update an item in a queue — response body — results
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent
traceId	string	Optional

Referenced models: Update an item in a queue — response body — results

Update an item in a queue — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location ID
modifiedPostPayload	JSON	Optional	Modifications to the original post
modifiedPostPayload (allOf 1)	Model	All variants apply	Expand Update an item in a queue — request body — body modified Post Payload account Ids, apply Watermark, category Id, created By, facebook Post Details, follow Up Comment, gmb Post Details, instagram Post Details, linkedin Post Details, location Id, media, og Tags Details, pinterest Post Details, post Approval Details, schedule Date, schedule Time Updated, selected Best Time, status, summary, tags, tiktok Post Details, type, user Id, youtube Post Details
newOrder	JSON	Optional	New order value or position keyword (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)
newOrder (oneOf 1)	number	Alternative
newOrder (oneOf 2)	string	Alternative
primaryImage	string	Optional	Primary media URL (image)
sessionId	string	Optional	Edit session ID
variations	array	Optional	Variations
variations[]	Model	Each item	Expand Update an item in a queue — request body — body variations item

Referenced models: Update an item in a queue — request body — body modified Post Payload account Ids, apply Watermark, category Id, created By, facebook Post Details, follow Up Comment, gmb Post Details, instagram Post Details, linkedin Post Details, location Id, media, og Tags Details, pinterest Post Details, post Approval Details, schedule Date, schedule Time Updated, selected Best Time, status, summary, tags, tiktok Post Details, type, user Id, youtube Post Details, Update an item in a queue — request body — body variations item

Update an item in a queue — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional	A message indicating the result of the operation.
queueItem	JSON	Optional	The updated queue item.
queueItem (allOf 1)	Model	All variants apply	Expand Clone a queue item — response body — results queue Item id, created At, current Variation, deleted, errors, last Scheduled Time, location Id, modified Post Payload, order, parent Post Id, post Id, primary Image, queue Id, updated At, variations
totalPostsChanged	JSON	Optional
totalPostsChanged (anyOf 1)	number	Alternative	Number of unique posts that had their slots changed
totalPostsChanged (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedSlots	array	Optional	Updated slot information for items affected by reorder operation
updatedSlots[]	Model	Each item	Expand Fetch slot information for queue items — response body — results slots item

Referenced models: Clone a queue item — response body — results queue Item id, created At, current Variation, deleted, errors, last Scheduled Time, location Id, modified Post Payload, order, parent Post Id, post Id, primary Image, queue Id, updated At, variations, Fetch slot information for queue items — response body — results slots item

Update an item in a queue — request body — body variations item

Field	Type	Presence	Description and constraints
$	object	Root
content	string	Optional	The text content of the variation.
mentions	array	Optional	Platform-specific mentions within the content (e.g., @username references).
mentions[]	object	Each item
ogTags	JSON	Optional	Open Graph tags for link previews.
ogTags (allOf 1)	Model	All variants apply	Expand Update an item in a queue — request body — body variations item og Tags meta Image, meta Link, og Title

Referenced models: Update an item in a queue — request body — body variations item og Tags meta Image, meta Link, og Title

Clone a queue item — response body — results queue Item id, created At, current Variation, deleted, errors, last Scheduled Time, location Id, modified Post Payload, order, parent Post Id, post Id, primary Image, queue Id, updated At, variations

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	The unique identifier of the queue item.
createdAt	string	Optional	Creation timestamp
currentVariation	JSON	Optional
currentVariation (anyOf 1)	number	Alternative	The index of the current variation being used for this post
currentVariation (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deleted	boolean	Optional	Indicates if the item is deleted
errors	array	Optional	List of errors associated with the queue item. Possible values: INVALID_USER_ID, PIXABAY_MEDIA.
errors[]	string	Each item
lastScheduledTime	JSON	Optional
lastScheduledTime (anyOf 1)	string	Alternative	Timestamp of the last scheduled post. Always null for a new queue. Format: date-time
lastScheduledTime (anyOf 2)	null	Alternative
locationId	string	Optional	Location ID
modifiedPostPayload	JSON	Optional	The formatted post data modified from original post.
modifiedPostPayload (allOf 1)	Model	All variants apply	Expand Clone a queue item — response body — results queue Item id, created At, current Variation, deleted, errors, last Scheduled Time, location Id, modified Post Payload, order, parent Post Id, post Id, primary Image, queue Id, updated At, variations modified Post Payload id, account Id, account Ids, created At, created By, display Date, error, facebook Post Details, gmb Post Details, instagram Post Details, linkedin Post Details, location Id, media, media Optimization, og Tags Details, pinterest Post Details, post Approval Details, post Id, published At, source, status, summary, tags, thumbnail, tiktok Post Details, type, updated At, user, youtube Post Details
order	JSON	Optional
order (anyOf 1)	number	Alternative	The order of the item in the queue.
order (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
parentPostId	string	Optional	The ID of the parent post before splitting to individual social posts.
postId	string	Optional	The ID of the original post, if any.
primaryImage	string	Optional	The primary image URL for the post.
queueId	string	Optional	The ID of the queue this post belongs to
updatedAt	string	Optional	Last update timestamp
variations	array	Optional	A list of content variations for the post.
variations[]	Model	Each item	Expand Fetch items from a queue — response body — results items item variations item

Referenced models: Clone a queue item — response body — results queue Item id, created At, current Variation, deleted, errors, last Scheduled Time, location Id, modified Post Payload, order, parent Post Id, post Id, primary Image, queue Id, updated At, variations modified Post Payload id, account Id, account Ids, created At, created By, display Date, error, facebook Post Details, gmb Post Details, instagram Post Details, linkedin Post Details, location Id, media, media Optimization, og Tags Details, pinterest Post Details, post Approval Details, post Id, published At, source, status, summary, tags, thumbnail, tiktok Post Details, type, updated At, user, youtube Post Details, Fetch items from a queue — response body — results items item variations item

Fetch slot information for queue items — response body — results slots item

Field	Type	Presence	Description and constraints
$	object	Root
isSkipped	boolean	Optional	Indicates if this time slot is skipped
itemId	string	Optional	The ID of the queue item
scheduledDateTime	JSON	Optional
scheduledDateTime (anyOf 1)	string	Alternative	The updated scheduled date/time for this item Format: date-time
scheduledDateTime (anyOf 2)	null	Alternative

Update an item in a queue — request body — body variations item og Tags meta Image, meta Link, og Title

Field	Type	Presence	Description and constraints
$	object	Root
metaImage	object	Optional	URL of the image to display in link preview.
metaLink	object	Optional	The canonical URL of the content for link preview.
ogTitle	object	Optional	Title to display in link preview.

Policy, approvals and errors

SDK function policy ID: gohighlevel.updatequeueitem. Catalog operation: updateQueueItem. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["socialplanner/category.write"]

Pinned headers: {"Version": "v3"}

Official provider source