HighLevel: Reset an item in a queue

← Social planner operations · Get started

Operation gohighlevel.resetqueueitem

Provider route: PUT /social-media-posting/category/queues/{queueId}/items/{itemId}/reset. 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"]["resetQueueItem"]>[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.resetQueueItem(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.reset_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 Reset an item in a queue — request body — body

Referenced models: Reset 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 Reset an item in a queue — response body

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

Schemas

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

Reset an item in a queue — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	Model	Required within parent	Expand Reset 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: Reset an item in a queue — response body — results

Reset an item in a queue — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location ID
sessionId	string	Optional	Edit session ID

Reset 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. Examples: "Queue item reset successfully", "Dummy queue item deleted successfully".
queueItem	JSON	Optional	The reset queue item, including its current variation.
queueItem (allOf 1)	Model	All variants apply	Expand Reset an item in a queue — response body — results queue Item id, current Variation, errors, is Skipped, order, post, post Id, primary Image, scheduled Date Time, scheduled Variation Index, variations

Referenced models: Reset an item in a queue — response body — results queue Item id, current Variation, errors, is Skipped, order, post, post Id, primary Image, scheduled Date Time, scheduled Variation Index, variations

Reset an item in a queue — response body — results queue Item id, current Variation, errors, is Skipped, order, post, post Id, primary Image, scheduled Date Time, scheduled Variation Index, variations

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	The unique identifier of the queue item.
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]+)?$
errors	array	Optional	List of errors associated with the queue item. Possible values: INVALID_USER_ID, PIXABAY_MEDIA.
errors[]	string	Each item
isSkipped	boolean	Optional	Indicates if this time slot is skipped and the post will not be published at this time
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]+)?$
post	JSON	Optional	The formatted post data.
post (allOf 1)	Model	All variants apply	Expand Get posts — response body — results count, posts posts item
postId	string	Optional	The ID of the original post, if any.
primaryImage	string	Optional	The primary image URL for the post.
scheduledDateTime	JSON	Optional
scheduledDateTime (anyOf 1)	string	Alternative	The calculated date/time when this item is scheduled to be posted Format: date-time
scheduledDateTime (anyOf 2)	null	Alternative
scheduledVariationIndex	JSON	Optional
scheduledVariationIndex (anyOf 1)	number	Alternative	The variation index that will be used when this item is posted
scheduledVariationIndex (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
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: Get posts — response body — results count, posts posts item, Fetch items from a queue — response body — results items item variations item

Fetch items from a queue — response body — results items item variations item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	The ID of the variation.
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 Fetch items from a queue — response body — results items item variations item og Tags meta Image, meta Link, og Title

Referenced models: Fetch items from a queue — response body — results items item variations item og Tags meta Image, meta Link, og Title

Get posts — response body — results count, posts posts item bluesky Post Details external Link, external Link Description, external Link Title, language, quote Post, reply To, shortened Links

Field	Type	Presence	Description and constraints
$	object	Root
externalLink	string	Optional	External URL to embed as a link card in the post.
externalLinkDescription	string	Optional	Description for the external link card. Brief summary displayed below the title.
externalLinkTitle	string	Optional	Title for the external link card. Displayed prominently in the embed.
language	string	Optional	ISO 639-1 language code for the post content. **Examples:** `en` (English), `es` (Spanish), `fr` (French), `de` (German)
quotePost	string	Optional	Bluesky AT Protocol URI of a post to quote. **Format:** `at://did:plc:{user-id}/app.bsky.feed.post/{post-id}` **Use Case:** Quote-post another user's post with your commentary.
replyTo	string	Optional	Bluesky AT Protocol URI of a post to reply to. **Format:** `at://did:plc:{user-id}/app.bsky.feed.post/{post-id}` **Use Case:** Create a reply thread to an existing Bluesky post.
shortenedLinks	array	Optional	Shortened links for the post (auto-generated).
shortenedLinks[]	string	Each item

Edit post — request body — body og Tags Details meta Image, meta Link, og Description, og Title

Field	Type	Presence	Description and constraints
$	object	Root
metaImage	string	Optional	Preview image URL for the shared link. **Best Practices:** - Use high-quality images (1200x630px recommended) - Ensure the image is publicly accessible **Auto-fetch:** Use the Get Metatags API to fetch OG data from a URL.
metaLink	string	Optional	URL of the webpage being shared. This is the destination when users click the link preview.
ogDescription	string	Optional	Custom description for the link preview. Overrides the page's og:description meta tag. **Tip:** Keep descriptions under 155 characters for optimal display.
ogTitle	string	Optional	Custom title for the link preview. Overrides the page's og:title meta tag. **Tip:** Keep titles concise (50-60 characters) for best display across platforms.

Get posts — response body — results / count, posts / posts / item / facebookPostDetails / type: post, story, reel

Field	Type	Presence	Description and constraints
$	object	Root
textFormatPresetId	string	Optional	Facebook background preset ID for text-only feed posts. **Facebook `post` only** — not `story` or `reel`. Ignored when media is attached; `metaLink` is omitted on publish. **Validations** — request returns `400` if violated: - Must be a valid preset ID from the [Facebook text background preset reference](https://help.leadconnectorhq.com/support/solutions/articles/155000008005-facebook-text-background-posts-preset-reference). Empty strings, whitespace-only values, and `null` are rejected. - When set, `summary` must be 130 characters or fewer.
type	string	Required within parent	Facebook post format type. **Available Types:** - `post` - Standard feed post (images, videos, text) - `story` - 24-hour temporary story - `reel` - Short-form vertical video **Restrictions:** - Reels: Require exactly 1 video, not supported on Groups - Stories: Captions not supported Known values: post, story, reel

Get posts — response body — results / count, posts / posts / item / instagramPostDetails / type: post, story, reel

Field	Type	Presence	Description and constraints
$	object	Root
collaborators	object	Optional	Object mapping account IDs to arrays of associated usernames for collaboration. Only allowed for type "post" and "reels"
publishViaPushNotification	boolean	Optional	Send Instagram Story via Push Notification instead of direct posting. Only applicable for Story type.
publisherNote	string	Optional	Note to the publisher for manual posting guidance. Only used when publishViaPushNotification is true.
showOnFeed	boolean	Optional	Show Reel on profile grid/feed. **✅ Applies to:** Reels only - `true` - Reel appears on your profile grid - `false` - Reel only appears in Reels tab
type	string	Required within parent	Instagram post format type. **Available Types:** - `post` - Standard feed post (images, videos, carousels) - `story` - 24-hour temporary story - `reel` - Short-form vertical video (up to 90 seconds) **Restrictions:** - Media is REQUIRED for all Instagram posts - Reels: Require exactly 1 video - Stories: Captions not supported, JPEG only for images Known values: post, story, reel

Policy, approvals and errors

SDK function policy ID: gohighlevel.resetqueueitem. Catalog operation: resetQueueItem. 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