HighLevel: Social planner schemas (part 1)

← Social planner operations · All schemas

Bulk Delete Social Planner Posts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
postIds	array	Optional	Requested Results
postIds[]	string	Each item

Bulk Delete Social Planner Posts — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Required within parent	Message and deleted count
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

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

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

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	MongoDB document ID of the post
accountId	string	Optional	Account Id
accountIds	array	Optional	Account Ids
accountIds[]	string	Each item
createdAt	string	Optional	Date when the post was created Format: date-time
createdBy	string	Optional	User ID who created the post
displayDate	string	Optional	Display date for the post Format: date-time
error	string	Required within parent	Error
facebookPostDetails	JSON	Optional	Facebook Post Details
facebookPostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results / count, posts / posts / item / facebookPostDetails / type: post, story, reel
gmbPostDetails	JSON	Optional	GMB Post Details
gmbPostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results / count, posts / posts / item / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER
instagramPostDetails	JSON	Optional	Instagram Post Details
instagramPostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results / count, posts / posts / item / instagramPostDetails / type: post, story, reel
linkedinPostDetails	JSON	Optional	Linkedin Post Details
linkedinPostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results count, posts posts item linkedin Post Details pdf Title, poll, post As Pdf
locationId	string	Required within parent	Location Id
media	array	Optional	Post Media Data The limitations of media as per the platforms is provided through the reference link in API description
media[]	Model	Each item	Expand Get posts — response body — results count, posts posts item media item
mediaOptimization	boolean	Optional	Pass this parameter to optimize the image media
ogTagsDetails	JSON	Optional	Og Tags Meta Data
ogTagsDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body og Tags Details meta Image, meta Link, og Description, og Title
pinterestPostDetails	JSON	Optional	Pinterest Post Details
pinterestPostDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body pinterest Post Details board Ids, link, pinterest Boards, shortened Links, title
postApprovalDetails	JSON	Optional	Post Approval Details
postApprovalDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results / count, posts / posts / item / postApprovalDetails / approvalStatus: pending, approved, rejected, not required
postId	string	Optional	Platform-specific post identifier
publishedAt	string	Optional	Date when the post was published
source	string	Optional	source must be one of the following values: composer, recurring, csv Known values: composer, csv, recurring, review, rss, template-library, category-queue, native
status	object	Optional	Status must be one of the following values: in_progress, draft, failed, published, scheduled, in_review, notification_sent, deleted
summary	string	Optional	Content text of the post
tags	array	Optional	Tag Ids
tags[]	string	Each item
thumbnail	string	Optional	Post-level cover image (thumbnail) URL. For posts that contain a video, this is the resolved cover image used for the first video in `media[]`. It is set automatically from the `thumbnail` provided on the first video media item at create/edit time, or auto-generated from the video when one is not supplied. Per-item thumbnails inside `media[]` are not retained on the response — the primary cover image lives on this field.
tiktokPostDetails	JSON	Optional	Tiktok Post Details
tiktokPostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results / count, posts / posts / item / tiktokPostDetails / privacyLevel: PUBLIC TO EVERYONE, MUTUAL FOLLOW FRIENDS, SELF ONLY
type	object	Required within parent	Post Type must be one of the following values: - post, story, reel
updatedAt	string	Optional	Date when the post was last updated Format: date-time
user	JSON	Optional	User
user (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
youtubePostDetails	JSON	Optional	Youtube Post Details
youtubePostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results / count, posts / posts / item / youtubePostDetails / privacyLevel: private, public, unlisted, type: video, short

Referenced models: Edit post — request body — body og Tags Details meta Image, meta Link, og Description, og Title, Get posts — response body — results / count, posts / posts / item / facebookPostDetails / type: post, story, reel, Get posts — response body — results / count, posts / posts / item / postApprovalDetails / approvalStatus: pending, approved, rejected, not required, Get posts — response body — results / count, posts / posts / item / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER, Get posts — response body — results / count, posts / posts / item / instagramPostDetails / type: post, story, reel, Get posts — response body — results count, posts posts item linkedin Post Details pdf Title, poll, post As Pdf, Edit post — request body — body pinterest Post Details board Ids, link, pinterest Boards, shortened Links, title, Get posts — response body — results count, posts posts item media item, Get posts — response body — results count, posts posts item user email, first Name, id, last Name, phone, profile Photo, title, Get posts — response body — results / count, posts / posts / item / tiktokPostDetails / privacyLevel: PUBLIC TO EVERYONE, MUTUAL FOLLOW FRIENDS, SELF ONLY, Get posts — response body — results / count, posts / posts / item / youtubePostDetails / privacyLevel: private, public, unlisted, type: video, short

Connect Account (Step 3 of 3) — request body — body / type: page

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Required within parent	Avatar or profile picture URL
name	string	Required within parent	Name of the Facebook page or account
originId	string	Required within parent	Original Facebook platform identifier
type	string	Required within parent	Type of Facebook account (must be page) One of: page

Connect Account (Step 3 of 3) — request body — body / type: page, group, profile, location, business — Attach Linkedin Account DTO

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Required within parent	Avatar or profile picture URL
name	string	Required within parent	Name of the LinkedIn page or profile
originId	string	Required within parent	Original LinkedIn platform identifier
type	string	Required within parent	Type of LinkedIn account (must be one of: page, profile) One of: page, group, profile, location, business
urn	string	Required within parent	LinkedIn URN (Uniform Resource Name) identifier

Connect Account (Step 3 of 3) — request body — body / type: page, group, profile, location, business — Attach Tiktok Account DTO

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Required within parent	Avatar or profile picture URL
name	string	Required within parent	Display name of the account
originId	string	Required within parent	Original platform-specific account identifier
type	string	Required within parent	Type of TikTok account One of: page, group, profile, location, business
username	string	Optional	Username or handle of the TikTok account
verified	boolean	Optional	Indicates if the TikTok account is verified

Connect Account (Step 3 of 3) — request body — body / type: profile — Attach Pinterest Account DTO

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	Avatar URL
companyId	string	Optional	Company ID
name	string	Optional	Name
originAccountType	string	Optional	Origin account type
originId	string	Required within parent	Origin ID
type	string	Optional	Account type must be one of the following values: profile One of: profile
username	string	Optional	Username
verified	boolean	Optional	Verification status
websiteUrl	string	Optional	Website URL

Connect Account (Step 3 of 3) — request body — body / type: profile — Attach Threads Account DTO

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Required within parent	Avatar URL
name	string	Required within parent	Account name
originId	string	Required within parent	Origin ID
type	string	Required within parent	Account type One of: profile

Connect Account (Step 3 of 3) — request body — body / type: profile — Attach Youtube Account Response DTO

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Required within parent	Avatar URL
name	string	Required within parent	Name
originId	string	Required within parent	Origin ID
type	string	Required within parent	Account type One of: profile
username	string	Optional	Username
verified	boolean	Optional	Verification status

Connect Account (Step 3 of 3) — request body — body account, location

Field	Type	Presence	Description and constraints
$	object	Root
account	object	Required within parent
account (allOf 1)	Model	All variants apply	Expand Connect Account (Step 3 of 3) — request body — body account, location account account Name, name, type, verification State, vetted State
location	object	Required within parent
location (allOf 1)	Model	All variants apply	Expand Connect Account (Step 3 of 3) — request body — body account, location location is Connected, is Verified, max Location, metadata, name, store Code, storefront Address, title

Referenced models: Connect Account (Step 3 of 3) — request body — body account, location account account Name, name, type, verification State, vetted State, Connect Account (Step 3 of 3) — request body — body account, location location is Connected, is Verified, max Location, metadata, name, store Code, storefront Address, title

Connect Account (Step 3 of 3) — request body — body account, location account account Name, name, type, verification State, vetted State

Field	Type	Presence	Description and constraints
$	object	Root
accountName	string	Required within parent	Display name of the account
name	string	Required within parent	Account name identifier
type	string	Required within parent	Type of the account
verificationState	string	Required within parent	State of account verification
vettedState	string	Required within parent	Vetting state of the account

Connect Account (Step 3 of 3) — request body — body account, location location is Connected, is Verified, max Location, metadata, name, store Code, storefront Address, title

Field	Type	Presence	Description and constraints
$	object	Root
isConnected	boolean	Optional	Whether the location is connected
isVerified	boolean	Optional	Whether the location is verified
maxLocation	boolean	Optional	Whether this is a max location
metadata	object	Optional	Additional metadata
name	string	Required within parent	Location name
storeCode	string	Optional	Store code
storefrontAddress	object	Optional	Storefront address details
title	string	Required within parent	Location title

Connect Account (Step 3 of 3) — request body — body avatar, name, origin Id, page Id

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	Avatar or profile picture URL
name	string	Optional	Display name of the account
originId	string	Optional	Original platform-specific account identifier
pageId	string	Required within parent	Facebook page ID associated with the Instagram account

Connect Account (Step 3 of 3) — response body — message, results, status Code, success results id, active, avatar, created At, deleted, location Id, meta, name, o Auth Id, old Id, origin Id, platform, type, updated At — Social Google Media Account Schema

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	MongoDB document ID of the social media account
active	boolean	Optional	Indicates if the account is currently active
avatar	string	Optional	Avatar or profile picture URL
createdAt	string	Optional	created date Format: date-time
deleted	boolean	Optional	Indicates if the account has been deleted
locationId	string	Optional	Location ID associated with this account
meta	object	Optional	Additional metadata for the account
name	string	Optional	Display name of the account
oAuthId	string	Optional	OAuth provider account identifier
oldId	string	Optional	Legacy account identifier for backward compatibility
originId	string	Optional	Original platform-specific account identifier
platform	object	Optional	Social media platform name
type	object	Optional	Type of account (e.g., location, page, profile)
updatedAt	string	Optional	updated date Format: date-time

Connect Account (Step 3 of 3) — response body — message, results, status Code, success results id, active, avatar, created At, deleted, location Id, meta, name, o Auth Id, old Id, origin Id, platform, type, updated At — Social Media Facebook Account Schema

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	MongoDB document ID of the social media account
active	boolean	Optional	Indicates if the account is currently active
avatar	string	Optional	Avatar or profile picture URL
createdAt	string	Optional	created date Format: date-time
deleted	boolean	Optional	Indicates if the account has been deleted
locationId	string	Optional	Location ID associated with this account
meta	object	Optional	Additional metadata for the account
name	string	Optional	Display name of the account
oAuthId	string	Optional	OAuth provider account identifier
oldId	string	Optional	Legacy account identifier for backward compatibility
originId	string	Optional	Original platform-specific account identifier
platform	object	Optional	Social media platform name
type	object	Optional	type value must be page
updatedAt	string	Optional	updated date Format: date-time

Connect Account (Step 3 of 3) — response body — message, results, status Code, success results id, active, avatar, created At, deleted, location Id, meta, name, o Auth Id, old Id, origin Id, platform, type, updated At — Social Media Linked In Account Schema

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	MongoDB document ID of the social media account
active	boolean	Optional	Indicates if the account is currently active
avatar	string	Optional	Avatar or profile picture URL
createdAt	string	Optional	created date Format: date-time
deleted	boolean	Optional	Indicates if the account has been deleted
locationId	string	Optional	Location ID associated with this account
meta	object	Optional	Additional metadata for the account
name	string	Optional	Display name of the account
oAuthId	string	Optional	OAuth provider account identifier
oldId	string	Optional	Legacy account identifier for backward compatibility
originId	string	Optional	Original platform-specific account identifier
platform	object	Optional	Social media platform name
type	object	Optional	type must be one of the following values: page, profile
updatedAt	string	Optional	updated date Format: date-time

Connect Account (Step 3 of 3) — response body — message, results, status Code, success results id, active, avatar, created At, deleted, location Id, meta, name, o Auth Id, old Id, origin Id, platform, type, updated At — Social Media Tiktok Account Schema

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	MongoDB document ID of the social media account
active	boolean	Optional	Indicates if the account is currently active
avatar	string	Optional	Avatar or profile picture URL
createdAt	string	Optional	created date Format: date-time
deleted	boolean	Optional	Indicates if the account has been deleted
locationId	string	Optional	Location ID associated with this account
meta	object	Optional	Additional metadata for the account
name	string	Optional	Display name of the account
oAuthId	string	Optional	OAuth provider account identifier
oldId	string	Optional	Legacy account identifier for backward compatibility
originId	string	Optional	Original platform-specific account identifier
platform	object	Optional	Social media platform name
type	object	Optional	type must be one of the following values: profile, business
updatedAt	string	Optional	updated date Format: date-time

Connect Account (Step 3 of 3) — response body — message, results, status Code, success — Social Media FBAccount Response DTO

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Optional	Requested Results
results (allOf 1)	Model	All variants apply	Expand Connect Account (Step 3 of 3) — response body — message, results, status Code, success results id, active, avatar, created At, deleted, location Id, meta, name, o Auth Id, old Id, origin Id, platform, type, updated At — Social Media Facebook Account Schema
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: Connect Account (Step 3 of 3) — response body — message, results, status Code, success results id, active, avatar, created At, deleted, location Id, meta, name, o Auth Id, old Id, origin Id, platform, type, updated At — Social Media Facebook Account Schema

Connect Account (Step 3 of 3) — response body — message, results, status Code, success — Social Media Gmb Account Response DTO

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Optional	Requested Results
results (allOf 1)	Model	All variants apply	Expand Connect Account (Step 3 of 3) — response body — message, results, status Code, success results id, active, avatar, created At, deleted, location Id, meta, name, o Auth Id, old Id, origin Id, platform, type, updated At — Social Google Media Account Schema
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: Connect Account (Step 3 of 3) — response body — message, results, status Code, success results id, active, avatar, created At, deleted, location Id, meta, name, o Auth Id, old Id, origin Id, platform, type, updated At — Social Google Media Account Schema

Connect Account (Step 3 of 3) — response body — message, results, status Code, success — Social Media Linked In Account Response DTO

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Optional	Requested Results
results (allOf 1)	Model	All variants apply	Expand Connect Account (Step 3 of 3) — response body — message, results, status Code, success results id, active, avatar, created At, deleted, location Id, meta, name, o Auth Id, old Id, origin Id, platform, type, updated At — Social Media Linked In Account Schema
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: Connect Account (Step 3 of 3) — response body — message, results, status Code, success results id, active, avatar, created At, deleted, location Id, meta, name, o Auth Id, old Id, origin Id, platform, type, updated At — Social Media Linked In Account Schema

Connect Account (Step 3 of 3) — response body — message, results, status Code, success — Social Media Pinterest Account Response DTO

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Optional	Requested Results
results (allOf 1)	Model	All variants apply	Expand Connect Account (Step 3 of 3) — response body — message, results, statusCode, success / results / platform: pinterest
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: Connect Account (Step 3 of 3) — response body — message, results, statusCode, success / results / platform: pinterest

Connect Account (Step 3 of 3) — response body — message, results, status Code, success — Social Media Tiktok Account Response DTO

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Optional	Requested Results
results (allOf 1)	Model	All variants apply	Expand Connect Account (Step 3 of 3) — response body — message, results, status Code, success results id, active, avatar, created At, deleted, location Id, meta, name, o Auth Id, old Id, origin Id, platform, type, updated At — Social Media Tiktok Account Schema
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: Connect Account (Step 3 of 3) — response body — message, results, status Code, success results id, active, avatar, created At, deleted, location Id, meta, name, o Auth Id, old Id, origin Id, platform, type, updated At — Social Media Tiktok Account Schema

Connect Account (Step 3 of 3) — response body — message, results, status Code, success — Social Media You Tube Account Response DTO

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Optional	Requested Results
results (allOf 1)	Model	All variants apply	Expand Connect Account (Step 3 of 3) — response body — message, results, statusCode, success / results / platform: youtube
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: Connect Account (Step 3 of 3) — response body — message, results, statusCode, success / results / platform: youtube

Connect Account (Step 3 of 3) — response body — message, results, statusCode, success / results / platform: pinterest

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (allOf 1)	Model	All variants apply	Expand Connect Account (Step 3 of 3) — response body — message, results, statusCode, success / results / platform: youtube avatar, name, origin Id
$ (allOf 2)	object	All variants apply
$ (allOf 2).platform	string	Optional	Known values: pinterest

Referenced models: Connect Account (Step 3 of 3) — response body — message, results, statusCode, success / results / platform: youtube avatar, name, origin Id

Connect Account (Step 3 of 3) — response body — message, results, statusCode, success / results / platform: youtube

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (allOf 1)	Model	All variants apply	Expand Connect Account (Step 3 of 3) — response body — message, results, statusCode, success / results / platform: youtube avatar, name, origin Id
$ (allOf 2)	object	All variants apply
$ (allOf 2).platform	string	Optional	Known values: youtube

Referenced models: Connect Account (Step 3 of 3) — response body — message, results, statusCode, success / results / platform: youtube avatar, name, origin Id

Connect Account (Step 3 of 3) — response body — message, results, statusCode, success / results / platform: youtube avatar, name, origin Id

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	Account Avatar URL
name	string	Required within parent	Account Name
originId	string	Required within parent	Origin ID

Create a comment or reply — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
attachments	array	Optional	Attachments for the comment (max 1 image). **Supported on:** Facebook only. **Not supported on:** Instagram, LinkedIn, TikTok, Bluesky, Community — the field is accepted by the API but the attachment will not appear on the comment. (Community processes the field server-side, but external URLs are not rendered due to its bucket restriction.)
attachments[]	Model	Each item	Expand Create a comment or reply — request body — body attachments item
content	string	Required within parent	Content of the comment. Per-platform max length: Facebook 8000, Instagram 2200, Linkedin 3000, Community 8000, Tiktok 150, Bluesky 300, Youtube 10000, Threads 500.
isParentThread	boolean	Required within parent	Set `true` to create a top-level comment on a post (parentId = post ID). Set `false` to create a reply to an existing comment (parentId = comment ID).
mentions	array	Optional	Mentions for the comment. **Supported on:** Facebook, LinkedIn, Community. **Ignored on:** Instagram, TikTok, Bluesky — the field is accepted but mentions are not rendered on these platforms.
mentions[]	Model	Each item	Expand Create a comment or reply — request body — body mentions item
notifyAllGroupMembers	boolean	Optional	When `true`, all members of the Community group receive a push/in-app notification about this comment — equivalent to an `@everyone` broadcast. **Supported on:** Community only. Ignored on all other platforms (the field is accepted but no notification is sent). **Independent of the `mentions` array** — you do not need to add an `@everyone` entry to `mentions` for this to take effect. Conversely, putting the literal text `@everyone` in `content` does **not** by itself trigger notifications; only this flag does. Defaults to `false` (no broadcast notification). Use `true` only when the comment is genuinely intended for every member of the group — overuse may cause members to mute the group.
parentId	string	Required within parent	For top-level comments (`isParentThread: true`): pass the post ID returned by the posts API. For replies (`isParentThread: false`): pass the parent comment ID returned by the list-comments API. In both cases this must be a valid 24-character Highlevel ID — not the native platform ID.

Referenced models: Create a comment or reply — request body — body attachments item, Create a comment or reply — request body — body mentions item

Create a comment or reply — request body — body attachments item

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	Type of the attachment One of: image
url	string	Required within parent	URL of the attachment

Create a comment or reply — request body — body mentions item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Mention ID
length	number	Required within parent	Mention length
name	string	Required within parent	Mention name
offset	number	Required within parent	Mention offset
slug	string	Optional	Mention slug for community profile link

Create a comment or reply — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Required within parent	The created comment
results (allOf 1)	Model	All variants apply	Expand Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At

Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Highlevel comment ID
attachments	array	Optional	Attachments on the comment
attachments[]	Model	Each item	Expand Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At attachments item
author	JSON	Optional	Author of the comment. May be partial or missing for some sync paths.
author (allOf 1)	Model	All variants apply	Expand Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At author id, name, profile Pic
content	string	Optional	Comment content. May be empty or missing for attachment-only comments.
createdAt	string	Optional	Time the comment record was created in Highlevel Format: date-time
isDeleted	boolean	Required within parent	Whether the comment was deleted
isEdited	boolean	Required within parent	Whether the comment was edited
isParentThread	boolean	Optional	True if this comment is a top-level comment on the post; false if it is a reply to another comment
isPost	boolean	Required within parent	True if this record represents the root post (not a comment)
isRead	boolean	Required within parent	Whether the comment has been read
level	JSON	Optional
level (anyOf 1)	number	Alternative	Comment depth (0 = post, 1 = comment, 2 = reply)
level (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
likeCount	JSON	Required within parent
likeCount (anyOf 1)	number	Alternative	Number of likes on the comment
likeCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
originId	string	Required within parent	Connected account / page ID on the native platform
platform	string	Required within parent	Platform the comment was posted on
platformCommentId	string	Optional	Native platform comment ID
platformParentId	string	Optional	Native platform parent ID (the post or comment this is a reply to)
platformPostId	string	Optional	Native platform post ID
postId	string	Required within parent	Highlevel post ID
previewLink	string	Optional	Direct link to view the comment on the native platform
publishedAt	string	Optional	Time the comment was published on the native platform. May be missing for legacy or webhook-synced records. Format: date-time
quoteCount	JSON	Required within parent
quoteCount (anyOf 1)	number	Alternative	Number of quote posts (platform-specific)
quoteCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reactionCount	JSON	Required within parent
reactionCount (anyOf 1)	number	Alternative	Number of reactions on the comment
reactionCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
replyCount	JSON	Required within parent
replyCount (anyOf 1)	number	Alternative	Number of replies to the comment
replyCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
repostCount	JSON	Required within parent
repostCount (anyOf 1)	number	Alternative	Number of reposts of the comment (platform-specific)
repostCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shareCount	JSON	Required within parent
shareCount (anyOf 1)	number	Alternative	Number of shares of the comment
shareCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Optional	Time the comment record was last updated in Highlevel Format: date-time

Referenced models: Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At attachments item, Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At author id, name, profile Pic

Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At attachments item

Field	Type	Presence	Description and constraints
$	object	Root
thumbnail	string	Optional	Thumbnail URL
type	string	Optional	Attachment MIME type or platform-specific type
url	string	Optional	Attachment URL
videoUrl	string	Optional	Video URL (when attachment is a video)

Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At author id, name, profile Pic

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	Platform author ID
name	string	Optional	Author display name
profilePic	string	Optional	Author profile picture URL

Create a new category queue — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
categoryId	string	Required within parent	Category ID
enableFuturePosts	boolean	Optional	Enable Future Posts. Defaults to false.
locationId	string	Required within parent	Location ID
prioritizeNewContent	boolean	Optional	Prioritize New Content. Defaults to false.
timeSlots	array	Required within parent
timeSlots[]	Model	Each item	Expand Create a new category queue — request body — body time Slots item
userId	string	Required within parent	User id

Referenced models: Create a new category queue — request body — body time Slots item

Create a new category queue — request body — body time Slots item

Field	Type	Presence	Description and constraints
$	object	Root
dayOfWeek	number	Required within parent	Day of the week (0-6)
time	string	Required within parent	Time in HH:mm format

Create a new category queue — response body

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

Create a new category queue — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional	A message indicating the result of the operation.
queue	JSON	Optional	The newly created queue.
queue (allOf 1)	Model	All variants apply	Expand Create a new category queue — response body — results / queue / status: active, paused, draft

Referenced models: Create a new category queue — response body — results / queue / status: active, paused, draft

Create a new category queue — response body — results / queue / status: active, paused, draft

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	Queue ID
categoryId	string	Optional	Category ID
createdAt	string	Optional	Creation timestamp Format: date-time
createdBy	string	Optional	ID of the user who created the queue
enableFuturePosts	boolean	Optional	Enable posting future content
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
prioritizeNewContent	boolean	Optional	Prioritize new content over older content
skipDateTime	array	Optional	Dates/times to skip posting. Always empty for a new queue.
skipDateTime[]	string	Each item	Format: date-time
startDate	string	Optional	Start date of the queue Format: date-time
status	string	Optional	Status of the queue. Always "draft" for a new queue. Known values: active, paused, draft
timeSlots	array	Optional	Time slots for scheduling posts
timeSlots[]	Model	Each item	Expand Create a new category queue — response body — results / queue / status: active, paused, draft time Slots item
totalPosts	JSON	Optional
totalPosts (anyOf 1)	number	Alternative	Total number of posts in the queue. Always 0 for a new queue.
totalPosts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Optional	Last update timestamp Format: date-time

Referenced models: Create a new category queue — response body — results / queue / status: active, paused, draft time Slots item

Create a new category queue — response body — results / queue / status: active, paused, draft time Slots item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	Time slot ID
dayOfWeek	JSON	Optional
dayOfWeek (anyOf 1)	number	Alternative	Day of the week (0=Sunday, 1=Monday, ...)
dayOfWeek (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
time	string	Optional	Time of the day (HH:mm format)

Create a new item in the queue — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
directToQueue	boolean	Optional	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.
locationId	string	Required within parent	Location ID
modifiedPostPayload	JSON	Optional	New post details
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
order	JSON	Optional	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.
order (oneOf 1)	number	Alternative
order (oneOf 2)	string	Alternative
primaryImage	string	Optional	Primary media URL (image) for the post. Falls back to modifiedPostPayload.primaryImage if not set.
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

Create a new item in the queue — response body

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

Create a new item in the 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 newly created 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

Delete Account — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Optional	Requested Results
results (allOf 1)	Model	All variants apply	Expand Delete Account — response body — results id, location Id
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: Delete Account — response body — results id, location Id

Delete Account — response body — results id, location Id

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	Id
locationId	string	Optional	Location Id

Delete CSV Post — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Optional	Requested Results
results (allOf 1)	Model	All variants apply	Expand Delete CSV Post — response body — results csv, post Id
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: Delete CSV Post — response body — results csv, post Id

Delete CSV Post — response body — results / csv, postId / csv / csvFileType: basic, advance, status: pending, in progress, completed, failed, in review, importing, deleted

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	CSV Id
applyWatermark	boolean	Optional	Apply watermark flag
csvFileType	string	Optional	CSV file type Known values: basic, advance
mediaOptimization	boolean	Optional	Media optimization flag
status	string	Optional	CSV import status Known values: pending, in_progress, completed, failed, in_review, importing, deleted
updatedAt	string	Optional	Date Updated Format: date-time

Delete CSV Post — response body — results csv, post Id

Field	Type	Presence	Description and constraints
$	object	Root
csv	JSON	Optional	CSV Data
csv (allOf 1)	Model	All variants apply	Expand Delete CSV Post — response body — results / csv, postId / csv / csvFileType: basic, advance, status: pending, in progress, completed, failed, in review, importing, deleted
postId	string	Required within parent	Post Id

Referenced models: Delete CSV Post — response body — results / csv, postId / csv / csvFileType: basic, advance, status: pending, in progress, completed, failed, in review, importing, deleted

Delete CSV — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Optional	Requested Results
results (allOf 1)	Model	All variants apply	Expand Delete CSV — response body — results csv
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: Delete CSV — response body — results csv

Delete CSV — response body — results / csv / csv / csvFileType: basic, advance, status: pending, in progress, completed, failed, in review, importing, deleted

Field	Type	Presence	Description and constraints
$	object	Root
accountIds	array	Optional	Account Ids
accountIds[]	string	Each item
applyWatermark	boolean	Optional	Apply watermark flag
approver	string	Optional	Approver User Id
count	JSON	Optional
count (anyOf 1)	number	Alternative	Number of posts in the CSV
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdBy	string	Optional	User Id who created the CSV import
csvFileType	string	Optional	CSV file type Known values: basic, advance
file	string	Optional	File path of the CSV
fileName	string	Optional	Name of the CSV file
locationId	string	Optional	Location Id
mediaOptimization	boolean	Optional	Media optimization flag
originId	string	Optional	Origin Id for tracking source
status	string	Optional	CSV import status Known values: pending, in_progress, completed, failed, in_review, importing, deleted
traceId	string	Optional	Trace Id for debugging
updatedAt	string	Optional	Date Updated Format: date-time

Delete CSV — response body — results csv

Field	Type	Presence	Description and constraints
$	object	Root
csv	JSON	Optional	CSV Data
csv (allOf 1)	Model	All variants apply	Expand Delete CSV — response body — results / csv / csv / csvFileType: basic, advance, status: pending, in progress, completed, failed, in review, importing, deleted

Referenced models: Delete CSV — response body — results / csv / csv / csvFileType: basic, advance, status: pending, in progress, completed, failed, in review, importing, deleted

Delete Post — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Optional	Requested Results
results (allOf 1)	Model	All variants apply	Expand Delete Post — response body — results post Id
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: Delete Post — response body — results post Id

Delete Post — response body — results post Id

Field	Type	Presence	Description and constraints
$	object	Root
postId	string	Optional	Platform-specific post identifier

Delete an item from a queue — response body

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

Delete an item from a queue — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional	A message indicating the result of the operation.
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 the operation
updatedSlots[]	Model	Each item	Expand Fetch slot information for queue items — response body — results slots item

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

Discard edit session changes — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	Model	Required within parent	Expand Discard edit session changes — 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: Discard edit session changes — response body — results

Discard edit session changes — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional	A message indicating the result of the operation.

Edit post — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
accountIds	array	Required within parent	Account IDs for the post. Each account ID identifies a connected social media account. **Get IDs from:** [Get Accounts API](./get-account) — use the `id` field from each account. **Validations:** - Required for non-draft posts - Must be a non-empty array - All account IDs must be valid connected accounts for the location
accountIds[]	string	Each item
applyWatermark	boolean	Optional	Apply watermark to media in this post. **Note:** Watermarks are applied to images only. Videos are not watermarked.
categoryId	string	Optional	Category ID to organize the post. Categories help group related posts. **Get Category IDs from:** [Get Categories API](./social-planner/get-categories-location-id) — use the `_id` field. **Validation:** Must be a valid MongoDB ObjectId.
createdBy	string	Optional	User ID of the creator who is creating/managing the post. Must be a valid MongoDB ObjectId. **Get User IDs from:** [Get User API](../users/get-user) — use the `id` field from the user object. **Validation:** Must be a valid MongoDB ObjectId.
facebookPostDetails	JSON	Optional	Facebook-specific post configuration. **Key Fields:** - `type`: Post type (`post`, `story`, `reel`) **Restrictions:** - Facebook Groups do NOT support Reels - Reels require exactly 1 video - Stories do not support captions **Reference:** [Platform Limitations Guide](https://help.leadconnectorhq.com/support/solutions/articles/48001240003-social-planner-image-video-content-and-api-limitations)
facebookPostDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / facebookPostDetails / type: post, story, reel
followUpComment	string	Optional	Follow-up comment to be posted immediately after the main post is published. **Supported Platforms:** Facebook, Instagram, LinkedIn, YouTube **NOT Supported:** TikTok, Google My Business (GMB), Pinterest **Use Case:** Great for adding hashtags, additional context, or engagement prompts without cluttering the main post. - Follow-up comment is automatically trimmed to platform limits **Reference:** [Platform Limitations Guide](https://help.leadconnectorhq.com/support/solutions/articles/48001240003-social-planner-image-video-content-and-api-limitations)
gmbPostDetails	JSON	Optional	GMB Post Details
gmbPostDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER
instagramPostDetails	JSON	Optional	Instagram-specific post configuration. **Key Fields:** - `type`: Post type (`post`, `story`, `reel`) - `collaborators`: Map of account IDs to Instagram usernames for collaboration invites (max 3 per account) - `showOnFeed`: Show reel on profile feed (for reels) **Collaborators Structure:** ```json { "accountId": ["username1", "username2"] } ``` Where `accountId` is from [Get Accounts API](./get-account) and usernames are Instagram handles without @. **Restrictions:** - Media is REQUIRED for all Instagram posts - Max 30 hashtags allowed in caption - Stories do not support captions - Collaborators: Posts/Reels only (NOT Stories) - Reels require exactly 1 video **Reference:** [Platform Limitations Guide](https://help.leadconnectorhq.com/support/solutions/articles/48001240003-social-planner-image-video-content-and-api-limitations)
instagramPostDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / instagramPostDetails / type: post, story, reel
linkedinPostDetails	JSON	Optional	LinkedIn-specific post configuration. **Key Fields:** - `postAsPdf`: Set to `true` to post images as a PDF carousel document - `pdfTitle`: Title for the PDF document (max 100 characters) **Limits:** - Max 9 images/videos for regular posts - Max 300 pages for PDF carousel - Max PDF size: 100 MB **Reference:** [Platform Limitations Guide](https://help.leadconnectorhq.com/support/solutions/articles/48001240003-social-planner-image-video-content-and-api-limitations)
linkedinPostDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body linkedin Post Details pdf Title, poll, post As Pdf
media	array	Optional	Post Media Data The limitations of media as per the platforms is provided through the reference link in API description
media[]	Model	Each item	Expand Edit post — request body — body media item
ogTagsDetails	JSON	Optional	Og Tags Meta Data
ogTagsDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body og Tags Details meta Image, meta Link, og Description, og Title
pinterestPostDetails	JSON	Optional	Pinterest-specific post configuration. Required when posting to Pinterest accounts. **Required Fields:** - `boardIds`: Object mapping account OAuth IDs to Pinterest board IDs **Optional Fields:** - `title`: Pin title (max 100 characters) - `link`: Destination URL for the pin (max 2048 characters) **Get Board IDs:** Use the Pinterest boards API or retrieve from connected account details. **Limits:** - Max 1 image/video per pin - Caption max 800 characters **Reference:** [Platform Limitations Guide](https://help.leadconnectorhq.com/support/solutions/articles/48001240003-social-planner-image-video-content-and-api-limitations)
pinterestPostDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body pinterest Post Details board Ids, link, pinterest Boards, shortened Links, title
postApprovalDetails	JSON	Optional	Post Approval Details
postApprovalDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / postApprovalDetails / approvalStatus: pending, approved, rejected, not required
scheduleDate	string	Optional	Schedule Date
scheduleTimeUpdated	boolean	Optional	Flag indicating if the schedule datetime was manually updated. Used for tracking rescheduled posts.
selectedBestTime	string	Optional	Selected Best Time slot for scheduling
status	string	Optional	Post status indicating the current state of the post. **Available Status Values:** - `draft` - Post saved as draft, not yet ready for publishing - `scheduled` - Post scheduled for future publishing (requires `scheduleDate`) - `in_review` - Post pending approval (requires `scheduleDate` and `postApprovalDetails`) - `published` - Post has been published - `in_progress` - Post is currently being processed - `pending` - Post is awaiting platform processing for Instagram media container creation - `failed` - Post publishing failed - `notification_sent` - Story notification sent (for manual story posting) - `deleted` - Post has been deleted **Validations:** - `scheduled` or `in_review` status requires `scheduleDate` to be set - Draft posts skip most validations (accountIds, media requirements) One of: draft, scheduled, in_review, published, in_progress, pending, failed, notification_sent, deleted
summary	string	Optional	Post content/caption text. Character limits vary by platform. **Custom Values & Hashtags:** - You can include custom values/variables in the content (e.g., `{{contact.name}}`) - Hashtags: Use `#hashtag` format. Instagram allows max 30 hashtags. - Mentions: Use platform-specific mention format (see `mentions` field for structured mentions) **Validations:** - Instagram/Facebook Story: Caption NOT supported for direct publishing - Facebook, LinkedIn, GMB: Content OR media is required (at least one) - Content is automatically trimmed to platform limits **Reference:** [Platform Limitations Guide](https://help.leadconnectorhq.com/support/solutions/articles/48001240003-social-planner-image-video-content-and-api-limitations)
tags	array	Optional	Array of Tag IDs to associate with the post for organization and filtering. **Get Tag IDs from:** [Get Tags API](./social-planner/get-tags-location-id) — use the `_id` field from each tag. **Validation:** All IDs must be valid MongoDB ObjectIds.
tags[]	string	Each item
tiktokPostDetails	JSON	Optional	Tiktok Post Details
tiktokPostDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / tiktokPostDetails / privacyLevel: PUBLIC TO EVERYONE, MUTUAL FOLLOW FRIENDS, SELF ONLY
type	string	Required within parent	Type of post to create. Determines the format and platform requirements. **Available Types:** - `post` - Standard feed post (all platforms) - `story` - Temporary 24-hour story (Instagram, Facebook) - `reel` - Short-form video content (Instagram, Facebook, TikTok, YouTube) **Customize Per Platform:** You can specify different content/types per platform using `facebookPostDetails.type`, `instagramPostDetails.type`, etc. **Validations:** - Reels require exactly 1 video - Stories: Caption not supported for Instagram/Facebook - Facebook Groups do not support Reels One of: post, story, reel
userId	string	Required within parent	User ID of the user creating/managing the post. Required for OAuth channel posts (non-draft).
youtubePostDetails	JSON	Optional	YouTube-specific post configuration. **Key Fields:** - `title`: Video title (max 100 characters) - `type`: Video type (`video` for regular videos, `short` for YouTube Shorts) - `privacyLevel`: Video visibility (`private`, `public`, `unlisted`) **Limits:** - Max 1 video per post - Caption (description) max 5,000 characters **Requirements:** - Video is REQUIRED for YouTube posts - `type` field is required
youtubePostDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / youtubePostDetails / privacyLevel: private, public, unlisted, type: video, short

Referenced models: Edit post — request body — body / facebookPostDetails / type: post, story, reel, Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER, Edit post — request body — body / instagramPostDetails / type: post, story, reel, Edit post — request body — body linkedin Post Details pdf Title, poll, post As Pdf, Edit post — request body — body og Tags Details meta Image, meta Link, og Description, og Title, Edit post — request body — body pinterest Post Details board Ids, link, pinterest Boards, shortened Links, title, Edit post — request body — body / postApprovalDetails / approvalStatus: pending, approved, rejected, not required, Edit post — request body — body media item, Edit post — request body — body / tiktokPostDetails / privacyLevel: PUBLIC TO EVERYONE, MUTUAL FOLLOW FRIENDS, SELF ONLY, Edit post — request body — body / youtubePostDetails / privacyLevel: private, public, unlisted, type: video, short

Edit post — request body — body / 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 One of: post, story, reel

Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER

Field	Type	Presence	Description and constraints
$	object	Root
actionType	string	Optional	Call-to-action button type for the post. **Available Actions:** - `none` - No action button - `order` - Order online - `book` - Book appointment - `shop` - Shop now - `learn_more` - Learn more - `call` - Call now (no URL required) - `sign_up` - Sign up **Note:** All actions except `none` and `call` require a `url`. One of: none, order, book, shop, learn_more, call, sign_up
couponCode	string	Optional	Promotional coupon code. Required for OFFER posts.
endDate	JSON	Optional	End date and time for EVENT or OFFER posts. **Required:** When `gmbEventType` is `EVENT` or `OFFER`. **Validation:** Must be after `startDate`. **Structure:** - `endDate`: { year, month, day } - `endTime`: { hours, minutes, seconds }
endDate (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER end Date end Date, end Time
gmbEventType	string	Required within parent	Google My Business post type. **Available Types:** - `STANDARD` - Regular update post (What's New) - `EVENT` - Event announcement with dates and title - `OFFER` - Promotional offer with coupon and redemption details **Required fields by type:** - STANDARD: None additional - EVENT: `title`, `startDate`, `endDate` - OFFER: `offerTitle`, `startDate`, `endDate`, `termsConditions`, `couponCode`, `redeemOnlineUrl` One of: STANDARD, EVENT, OFFER
offerTitle	string	Optional	Offer title. Required when `gmbEventType` is `OFFER`.
redeemOnlineUrl	string	Optional	URL where customers can redeem the offer online. Required for OFFER posts.
startDate	JSON	Optional	Start date and time for EVENT or OFFER posts. **Required:** When `gmbEventType` is `EVENT` or `OFFER`. **Structure:** - `startDate`: { year, month, day } - `startTime`: { hours, minutes, seconds }
startDate (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER start Date start Date, start Time
termsConditions	string	Optional	URL to terms and conditions page. Required for OFFER posts.
title	string	Optional	Event title. Required when `gmbEventType` is `EVENT`. **Max length:** 58 characters
url	string	Optional	Call-to-action URL. Required when `actionType` is set (except `none` and `call`). **Required for:** STANDARD and EVENT posts with actionType other than `none` or `call`.

Referenced models: Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER end Date end Date, end Time, Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER start Date start Date, start Time

Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER end Date end Date, end Time

Field	Type	Presence	Description and constraints
$	object	Root
endDate	JSON	Optional	End Date
endDate (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER end Date end Date, end Time end Date day, month, year
endTime	JSON	Optional	End Time
endTime (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER end Date end Date, end Time end Time hours, minutes, seconds

Referenced models: Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER end Date end Date, end Time end Date day, month, year, Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER end Date end Date, end Time end Time hours, minutes, seconds

Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER end Date end Date, end Time end Date day, month, year

Field	Type	Presence	Description and constraints
$	object	Root
day	number	Required within parent	Day component of the date (1-31)
month	number	Required within parent	Month component of the date (1-12)
year	number	Required within parent	Year component of the date

Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER end Date end Date, end Time end Time hours, minutes, seconds

Field	Type	Presence	Description and constraints
$	object	Root
hours	number	Required within parent	Hour component of the time (0-23)
minutes	number	Required within parent	Minute component of the time (0-59)
seconds	number	Required within parent	Second component of the time (0-59)

Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER start Date start Date, start Time

Field	Type	Presence	Description and constraints
$	object	Root
startDate	JSON	Optional	Start Date
startDate (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER end Date end Date, end Time end Date day, month, year
startTime	JSON	Optional	Start Time
startTime (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER end Date end Date, end Time end Time hours, minutes, seconds

Referenced models: Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER end Date end Date, end Time end Date day, month, year, Edit post — request body — body / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER end Date end Date, end Time end Time hours, minutes, seconds

Edit post — request body — body / 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 One of: post, story, reel

Edit post — request body — body / linkedinPostDetails / pdfTitle, poll, postAsPdf / poll / options, question, settings / settings / duration: ONE DAY, THREE DAYS, SEVEN DAYS, FOURTEEN DAYS

Field	Type	Presence	Description and constraints
$	object	Root
duration	string	Required within parent	Duration the poll stays open for votes. One of: ONE_DAY, THREE_DAYS, SEVEN_DAYS, FOURTEEN_DAYS

Edit post — request body — body / 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 One of: 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.
requesterNote	string	Optional	Note from the post creator to the approver explaining the post or requesting specific feedback.

Edit post — request body — body / tiktokPostDetails / privacyLevel: PUBLIC TO EVERYONE, MUTUAL FOLLOW FRIENDS, SELF ONLY

Field	Type	Presence	Description and constraints
$	object	Root
enableComment	boolean	Optional	Allow users to comment on the video. Default is determined by account settings.
enableDuet	boolean	Optional	Allow users to create Duet videos with your content. **Duet:** Side-by-side video featuring your content and the creator's reaction/addition.
enableStitch	boolean	Optional	Allow users to create Stitch videos with your content. **Stitch:** Clips up to 5 seconds of your video that creators can use in their own videos.
privacyLevel	string	Required within parent	Privacy level controlling who can view the video. **Available Values:** - `PUBLIC_TO_EVERYONE` - Anyone can view (default) - `MUTUAL_FOLLOW_FRIENDS` - Only mutual followers can view - `SELF_ONLY` - Only you can view (private) **Note:** If set to `SELF_ONLY`, `videoDisclosure` must be `false`. One of: PUBLIC_TO_EVERYONE, MUTUAL_FOLLOW_FRIENDS, SELF_ONLY
promoteOtherBrand	boolean	Optional	Indicates if the video promotes a third-party brand or product. **Required:** Must be `true` if `videoDisclosure` is enabled and you're promoting another brand.
promoteYourBrand	boolean	Optional	Indicates if the video promotes your own brand or product. **Required:** Must be `true` if `videoDisclosure` is enabled and you're promoting your own brand.
videoDisclosure	boolean	Optional	Enable branded content disclosure. Required when video is promotional content. **Validations:** - Cannot be `true` if `privacyLevel` is `SELF_ONLY` - If enabled, at least one of `promoteYourBrand` or `promoteOtherBrand` must be `true`

Edit post — request body — body / youtubePostDetails / privacyLevel: private, public, unlisted, type: video, short

Field	Type	Presence	Description and constraints
$	object	Root
privacyLevel	string	Optional	Video visibility/privacy setting. **Available Values:** - `public` - Anyone can search and view - `unlisted` - Only people with the link can view - `private` - Only you can view One of: private, public, unlisted
title	string	Optional	Video title displayed on YouTube. **Max length:** 100 characters **Best Practices:** - Include relevant keywords - Be descriptive but concise - Avoid clickbait
type	string	Required within parent	YouTube video format type. **Available Types:** - `video` - Standard YouTube video (landscape, any duration) - `short` - YouTube Shorts (vertical, up to 60 seconds) **Required field.** One of: video, short

Edit post — request body — body linkedin Post Details pdf Title, poll, post As Pdf

Field	Type	Presence	Description and constraints
$	object	Root
pdfTitle	string	Required within parent	Title for the PDF document carousel. Displayed as the document name on LinkedIn. **Max length:** 100 characters **Tip:** Use a descriptive title that explains the document content.
poll	JSON	Optional	Publish a LinkedIn poll post. **Required fields when `poll` is supplied:** - `question` (max 140 characters) - `options`: 2 to 4 entries, each `text` ≤ 30 characters; option texts must be unique - `settings.duration`: one of `ONE_DAY`, `THREE_DAYS`, `SEVEN_DAYS`, `FOURTEEN_DAYS` **LinkedIn restrictions:** - Polls cannot be edited after publishing. - A poll post cannot include `media` or a meta-link preview.
poll (allOf 1)	Model	All variants apply	Expand Edit post — request body — body linkedin Post Details pdf Title, poll, post As Pdf poll options, question, settings
postAsPdf	boolean	Required within parent	Post images as a PDF document carousel. **Limits:** - Max 300 pages/images - Max PDF size: 100 MB

Referenced models: Edit post — request body — body linkedin Post Details pdf Title, poll, post As Pdf poll options, question, settings

Edit post — request body — body linkedin Post Details pdf Title, poll, post As Pdf poll options, question, settings

Field	Type	Presence	Description and constraints
$	object	Root
options	array	Required within parent	Poll options. Minimum 2, maximum 4. Each option text max 30 characters. Option texts must be unique. Maximum items: 4 Minimum items: 2 Unique items: true
options[]	Model	Each item	Expand Edit post — request body — body linkedin Post Details pdf Title, poll, post As Pdf poll options, question, settings options item
question	string	Required within parent	Question for the poll. Max length: 140 characters. Maximum length: 140
settings	JSON	Required within parent	Poll settings (duration).
settings (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / linkedinPostDetails / pdfTitle, poll, postAsPdf / poll / options, question, settings / settings / duration: ONE DAY, THREE DAYS, SEVEN DAYS, FOURTEEN DAYS

Referenced models: Edit post — request body — body linkedin Post Details pdf Title, poll, post As Pdf poll options, question, settings options item, Edit post — request body — body / linkedinPostDetails / pdfTitle, poll, postAsPdf / poll / options, question, settings / settings / duration: ONE DAY, THREE DAYS, SEVEN DAYS, FOURTEEN DAYS

Edit post — request body — body linkedin Post Details pdf Title, poll, post As Pdf poll options, question, settings options item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
text	string	Required within parent	Text describing the option. Max length: 30 characters. Maximum length: 30

Edit post — request body — body media item

Field	Type	Presence	Description and constraints
$	object	Root
altText	string	Optional	Alt text for accessibility. Supported on Instagram, Threads, Pinterest, Bluesky, and LinkedIn image posts (ignored for video and other platforms). Auto-truncated per platform: Pinterest 500, Instagram/Threads 1000, Bluesky 2000, LinkedIn 4086 chars. Maximum length: 4086
caption	string	Optional	Alt text or caption for the media. Used for accessibility and SEO.
id	string	Optional	Unique identifier for the media item. Used for tracking and referencing.
isModified	boolean	Optional	Flag indicating if the media was modified (watermarked, optimized, or processed).
optimizedType	string	Optional	MIME type of the optimized media. May differ from original if format conversion occurred.
optimizedUrl	string	Optional	URL of the optimized/compressed media. Set automatically when media optimization is enabled. **Enable Optimization:** Set `mediaOptimization: true` in the post request.
originalUrl	string	Optional	Original media URL before any processing (watermarking/optimization). Set automatically by the system.
thumbnail	string	Optional	Cover image URL for a video media item. **Scope** - Applies to the **first video** in `media[]`. Values supplied on subsequent video items are ignored. - Has no effect on image-only media items. **Response behavior** - After the post is published, the resolved cover image is surfaced on the post-level `thumbnail` field of the response and is no longer echoed back inside `media[]`. This represents the post's primary cover image and the cover used for the first video. **Limitations** - Per-item thumbnails for multi-video posts are not supported. Each destination network exposes a single cover image per post for the leading video; this matches the behavior of the underlying social platform APIs. **Format** - Provide a publicly accessible JPEG or PNG URL. Animated formats and video URLs are not accepted. - Recommended: an image matching the orientation of your video and ≤ 2 MB.
type	string	Required within parent	MIME type of the media file. See Platform Limitations Guide for platform-specific format support. One of: image/jpeg, image/jpg, image/png, image/gif, video/mp4, video/mov, video/webm
url	string	Required within parent	Public URL of the media file. Must be a valid, accessible HTTPS URL.
watermarkedUrl	string	Optional	URL of the media after watermarking. Set automatically when watermark is applied.

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.

Edit post — request body — body pinterest Post Details board Ids, link, pinterest Boards, shortened Links, title

Field	Type	Presence	Description and constraints
$	object	Root
boardIds	object	Optional	**DEPRECATED — use `pinterestBoards` instead.** Will be removed on July 31, 2026. Legacy mapping of Pinterest account OAuth IDs to a single board ID: `{ accountOAuthId: "boardId" }` For multi-board posting, use `pinterestBoards`. Additional keys: see wildcard field
boardIds.*	string	Additional keys
link	string	Optional	Destination URL for the pin. Users clicking the pin will be directed to this URL. **Max length:** 2048 characters **Best Practices:** - Use direct links to relevant content - Track with UTM parameters for analytics
pinterestBoards	array	Optional	Per-account Pinterest board selection. Each entry binds one connected Pinterest account to a list of boards on that account. Each board produces an independent child post tracked separately for success/failure. Capped at 25 boards per account. When supplied, this field takes precedence over the deprecated `boardIds` field.
pinterestBoards[]	Model	Each item	Expand Edit post — request body — body pinterest Post Details board Ids, link, pinterest Boards, shortened Links, title pinterest Boards item
shortenedLinks	array	Optional	Shortened links for the post (auto-generated).
shortenedLinks[]	string	Each item
title	string	Optional	Pin title displayed on Pinterest. **Max length:** 100 characters **Best Practices:** - Include relevant keywords - Be descriptive and engaging

Referenced models: Edit post — request body — body pinterest Post Details board Ids, link, pinterest Boards, shortened Links, title pinterest Boards item

Edit post — request body — body pinterest Post Details board Ids, link, pinterest Boards, shortened Links, title pinterest Boards item

Field	Type	Presence	Description and constraints
$	object	Root	Per-account Pinterest board selection. Each entry binds one connected Pinterest account to a list of board IDs the pin should publish to. Each selected board produces an independent child post tracked separately for success/failure.
accountId	string	Required within parent	Connected Pinterest account ID. Must match one of the accounts referenced in the post's `userIds`.
boards	array	Required within parent	Pinterest board IDs to publish to on this account. Each board produces an independent child post. Capped at 25 boards per account. Maximum items: 25 Minimum items: 1
boards[]	string	Each item

Edit post — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Fetch a category queue by ID — response body

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

Fetch a category queue by ID — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional	A message indicating the result of the operation.
queue	JSON	Optional	The fetched queue along with its category metadata.
queue (allOf 1)	Model	All variants apply	Expand Fetch category queues for a location — response body — results queues item

Referenced models: Fetch category queues for a location — response body — results queues item

Fetch calendar view for an edit session — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
accountIds	array	Optional	Filter by Account IDs. If not provided or empty, returns all posts.
accountIds[]	string	Each item
endDate	string	Required within parent	End Date in ISO format
locationId	string	Required within parent	Location ID
sessionId	string	Required within parent	Edit session ID
startDate	string	Required within parent	Start Date in ISO format

Fetch calendar view for an edit session — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	Model	Required within parent	Expand Fetch calendar view for an edit session — 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: Fetch calendar view for an edit session — response body — results

Fetch calendar view for an edit session — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional
scheduledPosts	array	Optional
scheduledPosts[]	Model	Each item	Expand Fetch calendar view for an edit session — response body — results scheduled Posts item
timezone	string	Optional	The timezone used for scheduling, e.g., "Asia/Calcutta"
total	JSON	Optional
total (anyOf 1)	number	Alternative	Total number of scheduled posts returned
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Fetch calendar view for an edit session — response body — results scheduled Posts item

Fetch calendar view for an edit session — response body — results scheduled Posts item

Field	Type	Presence	Description and constraints
$	object	Root
category	JSON	Optional
category (anyOf 1)	JSON	Alternative	The category associated with this post
category (anyOf 1) (allOf 1)	Model	All variants apply	Expand Fetch category queues for a location — response body — results queues item category id, created At, created By, deleted, location Id, name, primary Color, secondary Color, updated At
category (anyOf 2)	null	Alternative
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
isDraft	boolean	Optional	Indicates this is a draft item from an edit session
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]+)?$
originalItemId	JSON	Optional
originalItemId (anyOf 1)	string	Alternative	Original queue item ID if this draft was created from an existing item
originalItemId (anyOf 2)	null	Alternative
post	JSON	Optional	The formatted post data.
post (allOf 1)	Model	All variants apply	Expand Get posts — response body — results count, posts posts item
primaryImage	string	Optional	The primary image URL for the post.
queueId	string	Optional	The ID of the queue this post belongs to
queueItemId	string	Optional	The unique identifier of the queue item.
scheduledDateTime	string	Optional	The date and time the post is scheduled to be published Format: date-time
timezone	string	Optional	The timezone in which the post is scheduled
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: Fetch category queues for a location — response body — results queues item category id, created At, created By, deleted, location Id, name, primary Color, secondary Color, updated At, Get posts — response body — results count, posts posts item, Fetch items from a queue — response body — results items item variations item

Fetch category queues for a location — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
limit	number	Optional	Maximum number of items to return
locationId	string	Required within parent	Location ID
skip	number	Optional	Number of items to skip

Fetch category queues for a location — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	Model	Required within parent	Expand Fetch category queues for a location — 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: Fetch category queues for a location — response body — results

Fetch category queues for a location — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional
meta	Model	Optional	Expand Fetch category queues for a location — response body — results meta
queues	array	Optional
queues[]	Model	Each item	Expand Fetch category queues for a location — response body — results queues item

Referenced models: Fetch category queues for a location — response body — results meta, Fetch category queues for a location — response body — results queues item

Fetch category queues for a location — response body — results meta

Field	Type	Presence	Description and constraints
$	object	Root
count	string	Optional	Total count of items

Fetch category queues for a location — response body — results queues item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	Queue ID
category	JSON	Optional	The category associated with the queue.
category (allOf 1)	Model	All variants apply	Expand Fetch category queues for a location — response body — results queues item category id, created At, created By, deleted, location Id, name, primary Color, secondary Color, updated At
categoryId	string	Optional	Category ID
createdAt	string	Optional	Creation timestamp Format: date-time
createdBy	string	Optional	ID of the user who created the queue
currentOrder	JSON	Optional
currentOrder (anyOf 1)	number	Alternative	Current order number in the queue
currentOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currentPostId	JSON	Optional
currentPostId (anyOf 1)	string	Alternative	ID of the currently scheduled post
currentPostId (anyOf 2)	null	Alternative
enableFuturePosts	boolean	Optional	Enable posting future content
lastScheduledTime	JSON	Optional
lastScheduledTime (anyOf 1)	string	Alternative	Timestamp of the last scheduled post Format: date-time
lastScheduledTime (anyOf 2)	null	Alternative
locationId	string	Optional	Location ID
prioritizeNewContent	boolean	Optional	Prioritize new content over older content
skipDateTime	array	Optional	Dates/times to skip posting
skipDateTime[]	string	Each item	Format: date-time
startDate	string	Optional	Start date of the queue Format: date-time
status	string	Optional	Status of the queue. Possible values: active, paused, draft. Known values: active, paused, draft
timeSlots	array	Optional	Time slots for scheduling posts
timeSlots[]	Model	Each item	Expand Fetch category queues for a location — response body — results queues item time Slots item
totalPosts	JSON	Optional
totalPosts (anyOf 1)	number	Alternative	Total number of posts in the queue
totalPosts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Optional	Last update timestamp Format: date-time

Referenced models: Fetch category queues for a location — response body — results queues item category id, created At, created By, deleted, location Id, name, primary Color, secondary Color, updated At, Fetch category queues for a location — response body — results queues item time Slots item

Fetch category queues for a location — response body — results queues item category id, created At, created By, deleted, location Id, name, primary Color, secondary Color, updated At

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	Category ID
createdAt	string	Optional	Creation timestamp
createdBy	string	Optional	ID of the user who created the category
deleted	boolean	Optional	Indicates if the category is deleted
locationId	string	Optional	Location ID
name	string	Optional	Name of the category
primaryColor	string	Optional	Primary color of the category
secondaryColor	string	Optional	Secondary color of the category
updatedAt	string	Optional	Last update timestamp

Fetch category queues for a location — response body — results queues item time Slots item

Field	Type	Presence	Description and constraints
$	object	Root
dayOfWeek	JSON	Required within parent
dayOfWeek (anyOf 1)	number	Alternative	Day of the week (0-6)
dayOfWeek (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
time	string	Required within parent	Time in HH:mm format

Fetch items from a queue — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
errorFilter	boolean	Optional	To return only queue items with errors
itemId	string	Optional	Item ID to center the response around. When provided, the response will position this item in the center with items above and below based on limit. The skip parameter is ignored when itemId is provided.
limit	number	Optional	Maximum number of items to return
locationId	string	Required within parent	Location ID
sessionId	string	Optional	Edit session ID
skip	number	Optional	Number of items to skip

Fetch items from a queue — response body

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

Fetch items from a queue — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
items	array	Optional
items[]	Model	Each item	Expand Fetch items from a queue — response body — results items item
message	string	Optional
meta	Model	Optional	Expand Fetch items from a queue — response body — results meta

Referenced models: Fetch items from a queue — response body — results meta, Fetch items from a queue — response body — results items item

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

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	The unique identifier of the queue item.
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

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

Field	Type	Presence	Description and constraints
$	object	Root
metaImage	object	Optional	URL of the content's primary image.
metaLink	object	Optional	The canonical URL of the content.
ogTitle	object	Optional	The title of the content.

Fetch items from a queue — response body — results meta

Field	Type	Presence	Description and constraints
$	object	Root
count	string	Optional	Total count of items
limit	JSON	Optional
limit (anyOf 1)	number	Alternative	Maximum number of items returned
limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
skip	JSON	Optional
skip (anyOf 1)	number	Alternative	Number of items skipped (offset from start)
skip (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fetch slot information for queue items — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
limit	number	Optional	Number of items to return Default: 20
locationId	string	Required within parent	The location ID
sessionId	string	Optional	Session ID for edit mode. If not provided, calculates slots for live items.
skip	number	Optional	Number of items to skip Default: 0

Fetch slot information for queue items — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	Model	Required within parent	Expand Fetch slot information for queue items — 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: Fetch slot information for queue items — response body — results