HighLevel: Clone a queue item

← Social planner operations · Get started

Operation gohighlevel.clonequeueitem

Provider route: POST /social-media-posting/category/queues/{queueId}/items/{itemId}/clone. 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"]["cloneQueueItem"]>[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.cloneQueueItem(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.clone_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 Clone a queue item — request body — body

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

Referenced models: Clone a queue item — response body

Schemas

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

Clone a queue item — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location ID
order	number	Required within parent	Order for the cloned item (typically between source and next item)
sessionId	string	Required within parent	Edit session ID

Clone a queue item — response body

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

Clone a queue item — 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 cloned 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

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

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 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

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 / postApprovalDetails / approvalStatus: pending, approved, rejected, not required

Field	Type	Presence	Description and constraints
$	object	Root
approvalStatus	string	Optional	Current approval status of the post. **Available Values:** - `pending` - Awaiting approver review - `approved` - Approved and ready for publishing - `rejected` - Rejected by approver (needs revision) - `not_required` - No approval workflow needed Known values: pending, approved, rejected, not_required
approver	string	Optional	User ID of the designated approver. **Note:** The approver will receive a notification when a post is submitted for review.
approverNote	string	Optional	Note from the approver to the post creator with feedback or approval comments.
approverUser	JSON	Optional	Approver User Details
approverUser (allOf 1)	Model	All variants apply	Expand Get posts — response body — results count, posts posts item user email, first Name, id, last Name, phone, profile Photo, title
requesterNote	string	Optional	Note from the post creator to the approver explaining the post or requesting specific feedback.

Referenced models: Get posts — response body — results count, posts posts item user email, first Name, id, last Name, phone, profile Photo, title

Policy, approvals and errors

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