HighLevel: Social planner schemas (part 2)

← Social planner operations · All schemas

Fetch slot information for queue items — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
limit	JSON	Optional
limit (anyOf 1)	number	Alternative	Number of items returned
limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
message	string	Optional
skip	JSON	Optional
skip (anyOf 1)	number	Alternative	Number of items skipped
skip (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
slots	array	Optional	Slot information for items in the requested range
slots[]	Model	Each item	Expand Fetch slot information for queue items — response body — results slots item
timezone	string	Optional	Timezone used for slot calculations
total	JSON	Optional
total (anyOf 1)	number	Alternative	Total number of items in the queue
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

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

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

Get Accounts — 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 Get Accounts — response body — results accounts, groups
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: Get Accounts — response body — results accounts, groups

Get Accounts — response body — results accounts, groups

Field	Type	Presence	Description and constraints
$	object	Root
accounts	array	Optional	Array of connected social media accounts
accounts[]	Model	Each item	Expand Get Accounts — response body — results accounts, groups accounts item
groups	array	Optional	Array of account groups
groups[]	Model	Each item	Expand Get Accounts — response body — results accounts, groups groups item

Referenced models: Get Accounts — response body — results accounts, groups accounts item, Get Accounts — response body — results accounts, groups groups item

Get Accounts — response body — results accounts, groups accounts item

Field	Type	Presence	Description and constraints
$	object	Root
expire	string	Optional	Token expiration date and time
id	string	Optional	Unique identifier for the connected account
isExpired	boolean	Optional	Indicates if the account token has expired
meta	object	Optional	Additional metadata for the account
name	string	Optional	Display name of the account
oauthId	string	Optional	OAuth provider account identifier
platform	string	Optional	platform must be one of the following values: google, facebook, instagram, linkedin, tiktok
profileId	string	Optional	Profile identifier from the social media platform
type	string	Optional	Type of account (e.g., location, page, profile)

Get Accounts — response body — results accounts, groups groups item

Field	Type	Presence	Description and constraints
$	object	Root
accountIds	array	Required within parent	Array of account IDs belonging to this group
accountIds[]	string	Each item
id	string	Required within parent	Group Id
name	string	Required within parent	name of group

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results accounts

Field	Type	Presence	Description and constraints
$	object	Root
accounts	array	Optional	Instagram Account Details
accounts[]	Model	Each item	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results accounts accounts item

Referenced models: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results accounts accounts item

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results accounts accounts item

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	Avatar or profile picture URL
id	string	Optional	Instagram account identifier
isConnected	boolean	Optional	Indicates if the account is currently connected
name	string	Optional	Display name of the Instagram account
pageId	string	Optional	Facebook page ID associated with the Instagram account

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations

Field	Type	Presence	Description and constraints
$	object	Root
locations	JSON	Optional	Locations
locations (allOf 1)	Model	All variants apply	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations locations account, location

Referenced models: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations locations account, location

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations locations account, location

Field	Type	Presence	Description and constraints
$	object	Root
account	JSON	Optional	Google Account Details
account (allOf 1)	Model	All variants apply	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations locations account, location account account Name, name, type, verification State, vetted State
location	JSON	Optional	Google Location Details
location (allOf 1)	Model	All variants apply	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations locations account, location location is Connected, is Verified, max Location, metadata, name, relationship Data, store Code, storefront Address, title

Referenced models: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations locations account, location account account Name, name, type, verification State, vetted State, Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations locations account, location location is Connected, is Verified, max Location, metadata, name, relationship Data, store Code, storefront Address, title

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations locations account, location account account Name, name, type, verification State, vetted State

Field	Type	Presence	Description and constraints
$	object	Root
accountName	string	Optional	Display name of the Google Business account
name	string	Optional	Google Business account identifier
type	string	Optional	Type of Google Business account
verificationState	string	Optional	Verification state of the account
vettedState	string	Optional	Vetted state of the account by Google

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations locations account, location location is Connected, is Verified, max Location, metadata, name, relationship Data, store Code, storefront Address, title

Field	Type	Presence	Description and constraints
$	object	Root
isConnected	boolean	Optional	Indicates if the location is currently connected
isVerified	boolean	Optional	Indicates if the location is verified by Google
maxLocation	boolean	Optional	Indicates if location limit has been reached
metadata	object	Optional	Meta data not related to User
name	string	Optional	Google Business account identifier
relationshipData	object	Optional	All locations and chain related to this one
storeCode	string	Optional	Store code or location identifier
storefrontAddress	object	Optional	Store front address
title	string	Optional	Business location title or name

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages

Field	Type	Presence	Description and constraints
$	object	Root
pages	array	Optional	Facebook Pages Details
pages[]	Model	Each item	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages pages item

Referenced models: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages pages item

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages pages item

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	Avatar or profile picture URL of the page
id	string	Optional	Facebook page identifier
isConnected	boolean	Optional	Indicates if the page is currently connected
isOwned	boolean	Optional	Indicates if the user owns this page
name	string	Optional	Name of the Facebook page

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages, profile

Field	Type	Presence	Description and constraints
$	object	Root
pages	array	Optional	LinkedIn Pages
pages[]	Model	Each item	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages, profile pages item
profile	array	Optional	LinkedIn Profile Details
profile[]	Model	Each item	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages, profile profile item

Referenced models: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages, profile pages item, Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages, profile profile item

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages, profile pages item

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	Profile Avatar url
id	string	Optional	Page ID
isConnected	boolean	Optional	is connected to app
name	string	Optional	LinkedIn Page Name
urn	string	Optional	URN

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages, profile profile item

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	Profile avatar
id	string	Optional	Id
isConnected	boolean	Optional	is connected to app
name	string	Optional	Name of profile
urn	string	Optional	URN

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile profile item — Pinterest Profile Schema

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	Avatar of profile account
id	string	Optional	Id
isConnected	boolean	Optional	Is connected
name	string	Optional	Name of account
type	string	Optional	Pinterest Account Type
username	string	Optional	Username of account
websiteUrl	string	Optional	Pinterest Account website Url

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile profile item — Tiktok Profile Schema

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	Avatar of profile account
id	string	Optional	Id
isConnected	boolean	Optional	Is connected
name	string	Optional	Name of account
type	object	Optional	Tiktok Account Type must be one of the following values: business, profile
username	string	Optional	Username of account
verified	boolean	Optional	Is verified

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile profile item — Youtube Profile Schema

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	Avatar of profile account
id	string	Optional	Id
isConnected	boolean	Optional	Is connected
name	string	Optional	Name of account
type	string	Optional	Youtube Account Type
username	string	Optional	Username of account
verified	boolean	Optional	Is verified

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Pinterest Account Schema

Field	Type	Presence	Description and constraints
$	object	Root
profile	array	Optional	Pinterest Profile
profile[]	Model	Each item	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile profile item — Pinterest Profile Schema

Referenced models: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile profile item — Pinterest Profile Schema

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Tiktok Account Schema

Field	Type	Presence	Description and constraints
$	object	Root
profile	array	Optional	Tiktok Business Account
profile[]	Model	Each item	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile profile item — Tiktok Profile Schema

Referenced models: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile profile item — Tiktok Profile Schema

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Tiktok Business Account Schema

Field	Type	Presence	Description and constraints
$	object	Root
profile	array	Optional	Tiktok Profile
profile[]	Model	Each item	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile profile item — Tiktok Profile Schema

Referenced models: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile profile item — Tiktok Profile Schema

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Youtube Account Schema

Field	Type	Presence	Description and constraints
$	object	Root
profile	array	Optional	Youtube Profile
profile[]	Model	Each item	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile profile item — Youtube Profile Schema

Referenced models: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile profile item — Youtube Profile Schema

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Facebook Accounts 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 Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages
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: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Google Location 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 Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations
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: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Instagram Accounts 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 Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results accounts
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: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results accounts

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Linked In Accounts 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 Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages, profile
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: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages, profile

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Pinterest Accounts 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 Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Pinterest 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: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Pinterest Account Schema

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get 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 Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get 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: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Tiktok Account Schema

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Tiktok Business 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 Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Tiktok Business 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: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Tiktok Business Account Schema

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get You Tube Accounts 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 Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Youtube 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: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Youtube Account Schema

Get 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 Get CSV Post — response body — results count, csv, posts
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: Get CSV Post — response body — results count, csv, posts

Get CSV Post — response body — results count, csv, posts

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Optional
count (anyOf 1)	number	Alternative	Total count of posts in CSV
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
csv	JSON	Optional	CSV Data
csv (allOf 1)	Model	All variants apply	Expand Get Upload Status — response body — results count, csvs csvs item
posts	array	Optional	CSV Posts
posts[]	Model	Each item	Expand Get CSV Post — response body — results count, csv, posts posts item

Referenced models: Get Upload Status — response body — results count, csvs csvs item, Get CSV Post — response body — results count, csv, posts posts item

Get CSV Post — response body — results count, csv, posts posts item

Field	Type	Presence	Description and constraints
$	object	Root
accountIds	array	Optional	Account Ids
accountIds[]	string	Each item
applyWatermark	boolean	Optional	Apply watermark flag
csvFileType	string	Optional	CSV file type Known values: basic, advance
errorMessage	string	Optional	Error Description
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 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
link	JSON	Optional	OG Tag
link (allOf 1)	Model	All variants apply	Expand Get CSV Post — response body — results count, csv, posts posts item link error, og Description, og Image, og Site Name, og Title, og Url, url
mediaOptimization	boolean	Optional	Media optimization flag
medias	array	Optional	Post Media List
medias[]	Model	Each item	Expand Get CSV Post — response body — results count, csv, posts posts item medias item
scheduleDate	string	Optional	Schedule date for the post in ISO format
status	string	Optional	Post status Known values: pending, accepted, rejected, deleted
summary	string	Optional	Post content/summary
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	string	Optional	Post type - post, story, or reel
updatedAt	string	Optional	Date Updated Format: date-time

Referenced models: Get CSV Post — response body — results count, csv, posts posts item medias item, 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 CSV Post — response body — results count, csv, posts posts item link error, og Description, og Image, og Site Name, og Title, og Url, url, Get posts — response body — results / count, posts / posts / item / tiktokPostDetails / privacyLevel: PUBLIC TO EVERYONE, MUTUAL FOLLOW FRIENDS, SELF ONLY

Get CSV Post — response body — results count, csv, posts posts item link error, og Description, og Image, og Site Name, og Title, og Url, url

Field	Type	Presence	Description and constraints
$	object	Root
error	string	Optional	Og Tag Error
ogDescription	string	Optional	Tag description
ogImage	JSON	Optional	OG Image data
ogImage (allOf 1)	Model	All variants apply	Expand Get CSV Post — response body — results count, csv, posts posts item link error, og Description, og Image, og Site Name, og Title, og Url, url og Image height, type, url, width
ogSiteName	string	Optional	Site Name
ogTitle	string	Optional	Tag Title
ogUrl	string	Optional	Tag Url
url	string	Optional	Tag url

Referenced models: Get CSV Post — response body — results count, csv, posts posts item link error, og Description, og Image, og Site Name, og Title, og Url, url og Image height, type, url, width

Get CSV Post — response body — results count, csv, posts posts item link error, og Description, og Image, og Site Name, og Title, og Url, url og Image height, type, url, width

Field	Type	Presence	Description and constraints
$	object	Root
height	JSON	Optional
height (anyOf 1)	number	Alternative	Image height
height (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Optional	Image Type
url	string	Optional	Image url
width	JSON	Optional
width (anyOf 1)	number	Alternative	Image width
width (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get CSV Post — response body — results count, csv, posts posts item medias item

Field	Type	Presence	Description and constraints
$	object	Root
aspectRatio	JSON	Optional
aspectRatio (anyOf 1)	number	Alternative	Media Aspect Ratio
aspectRatio (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
audioChannels	JSON	Optional
audioChannels (anyOf 1)	number	Alternative	Audio Channel
audioChannels (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
audioCodecName	string	Optional	Audio Codec
displayAspectRatio	string	Optional	Display Aspect Ratio
duration	JSON	Optional
duration (anyOf 1)	number	Alternative	Media Aspect Ratio
duration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
error	string	Optional	Error
facebookError	string	Optional	Facebook media error. It can be one of the following errors: imageSize, imageType, videoDuration, videoSize
format	string	Optional	Media format
frameRate	JSON	Optional
frameRate (anyOf 1)	number	Alternative	Video Frame Rate
frameRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
frames	array	Optional	List of frames
frames[]	string	Each item
gmbError	string	Optional	GMB media error. It can be one of the following errors: imageSize, imageDimension, imageType
height	JSON	Optional
height (anyOf 1)	number	Alternative	Media Height
height (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
instagramError	string	Optional	Instagram media error. It can be one of the following errors: imageSize, imageType, videoType, videoDuration, videoSize, videoAspectRatio, videoWidthHeight, audioCodec, audioCodecChannels, videoCodec, videoFrameRate
invalidError	string	Optional	Media error. It can be one of the following values: imageSize, imageWidth
linkedinError	string	Optional	LinkedIn media error. It can be one of the following errors: imageSize, imageType, videoType, videoDuration, videoSize
selectedPoster	JSON	Optional
selectedPoster (anyOf 1)	number	Alternative	Selected Poster
selectedPoster (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
size	JSON	Optional
size (anyOf 1)	number	Alternative	Media Size
size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tiktokBusinessError	string	Optional	Tikok Business media error. It can be one of the following errors: videoType, videoDuration, videoSize, videoWidthHeight, videoCodec, videoFrameRate
tiktokError	string	Optional	Tiktok media error. It can be one of the following errors: videoType, videoDuration, videoSize, videoWidthHeight, videoCodec, videoFrameRate
twitterError	string	Optional	Twitter media error. It can be one of the following errors: imageSize, videoType, videoDuration, videoSize
type	string	Optional	Media Type
url	string	Optional	Media Url
videoCodecName	string	Optional	Video Codec
width	JSON	Optional
width (anyOf 1)	number	Alternative	Media Width
width (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Upload Status — 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 Get Upload Status — response body — results count, csvs
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: Get Upload Status — response body — results count, csvs

Get Upload Status — response body — results count, csvs

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Required within parent
count (anyOf 1)	number	Alternative	Total count of CSV records
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
csvs	array	Required within parent	CSV Data
csvs[]	Model	Each item	Expand Get Upload Status — response body — results count, csvs csvs item

Referenced models: Get Upload Status — response body — results count, csvs csvs item

Get Upload Status — response body — results count, csvs csvs item

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 Id
channel	string	Optional	Channel
count	JSON	Optional
count (anyOf 1)	number	Alternative	Posts count
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	string	Optional	Date Created Format: date-time
createdBy	string	Optional	Created By Id
csvFileType	string	Optional	CSV file type Known values: basic, advance
file	string	Optional	File path
fileName	string	Optional	File Name
id	string	Optional	CSV Id
locationId	string	Optional	Location Id
mediaOptimization	boolean	Optional	Media optimization flag
originId	string	Optional	Origin Id
status	string	Optional	CSV import status Known values: pending, in_progress, completed, failed, in_review, importing, deleted
traceId	string	Optional	Trace Id
updatedAt	string	Optional	Date Updated Format: date-time

Get all categories with their queue status — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	Model	Required within parent	Expand Get all categories with their queue status — 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: Get all categories with their queue status — response body — results

Get all categories with their queue status — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
categories	array	Optional	List of categories with queue status
categories[]	Model	Each item	Expand Get all categories with their queue status — response body — results categories item
message	string	Optional
meta	Model	Optional	Expand Fetch category queues for a location — response body — results meta

Referenced models: Fetch category queues for a location — response body — results meta, Get all categories with their queue status — response body — results categories item

Get all categories with their queue status — response body — results categories item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	Category ID
createdAt	string	Optional	Creation timestamp
createdBy	string	Optional	Creator user ID
deleted	boolean	Optional	Indicates if deleted
locationId	string	Optional	Location ID
name	string	Optional	Category name
primaryColor	string	Optional	Primary color (hex)
publishedPostsCount	JSON	Optional
publishedPostsCount (anyOf 1)	number	Alternative	Published posts count
publishedPostsCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
queueDetails	JSON	Optional
queueDetails (anyOf 1)	JSON	Alternative	Queue details (present when in_queue or draft)
queueDetails (anyOf 1) (allOf 1)	Model	All variants apply	Expand Get all categories with their queue status — response body — results categories item queue Details Queue details (present when in queue or draft) enable Future Posts, prioritize New Content, queue Id
queueDetails (anyOf 2)	null	Alternative
secondaryColor	string	Optional	Secondary color (hex)
status	string	Optional	Status: available (no queue), in_queue (active/paused), or draft Known values: available, in_queue, draft
updatedAt	string	Optional	Last update timestamp

Referenced models: Get all categories with their queue status — response body — results categories item queue Details Queue details (present when in queue or draft) enable Future Posts, prioritize New Content, queue Id

Get all categories with their queue status — response body — results categories item queue Details Queue details (present when in queue or draft) enable Future Posts, prioritize New Content, queue Id

Field	Type	Presence	Description and constraints
$	object	Root
enableFuturePosts	boolean	Optional	Enable posting future content
prioritizeNewContent	boolean	Optional	Prioritize new content over older content
queueId	string	Optional	Queue ID

Get categories by id — 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 Get categories by id — response body — results category
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: Get categories by id — response body — results category

Get categories by id — response body — results category

Field	Type	Presence	Description and constraints
$	object	Root
category	JSON	Optional	Category Schema
category (allOf 1)	Model	All variants apply	Expand Get categories by id — response body — results category category id, created At, created By, deleted, location Id, message, name, primary Color, secondary Color, updated At

Referenced models: Get categories by id — response body — results category category id, created At, created By, deleted, location Id, message, name, primary Color, secondary Color, updated At

Get categories by id — response body — results category category id, created At, created By, deleted, location Id, message, name, primary Color, secondary Color, updated At

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	ID
createdAt	string	Optional	Format: date-time
createdBy	string	Optional	Created By User
deleted	boolean	Required within parent	Deleted Value
locationId	string	Optional	Location ID
message	string	Optional	Message
name	string	Optional	Category Name
primaryColor	string	Optional	Color For Category
secondaryColor	string	Optional	Secondary Color
updatedAt	string	Optional	Format: date-time

Get categories by location id — 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 Get categories by location id — response body — results categories, 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

Referenced models: Get categories by location id — response body — results categories, count

Get categories by location id — response body — results categories, count

Field	Type	Presence	Description and constraints
$	object	Root
categories	array	Required within parent	Meta Data
categories[]	Model	Each item	Expand Get categories by location id — response body — results categories, count categories item
count	JSON	Required within parent
count (anyOf 1)	number	Alternative	Count
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get categories by location id — response body — results categories, count categories item

Get categories by location id — response body — results categories, count categories item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	ID
createdAt	string	Optional	Format: date-time
createdBy	string	Optional	Created By User
deleted	boolean	Required within parent	Deleted Value
locationId	string	Optional	Location ID
name	string	Optional	Category Name
primaryColor	string	Optional	Color For Category
secondaryColor	string	Optional	Secondary Color
updatedAt	string	Optional	Format: date-time

Get 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 Get post — response body — results post
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: Get post — response body — results post

Get post — response body — results post

Field	Type	Presence	Description and constraints
$	object	Root
post	JSON	Optional	Post Data
post (allOf 1)	Model	All variants apply	Expand Get posts — response body — results count, posts posts item

Referenced models: Get posts — response body — results count, posts posts item

Get posts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
accounts	string	Optional	List of account Ids separated by comma as a string
fromDate	string	Required within parent	From Date
includeUsers	string	Required within parent	Include User Data
limit	string	Required within parent	Maximum number of records to return Default: 10
postType	object	Optional	Post Type must be one of the following values: - post, story, reel
skip	string	Required within parent	Number of records to skip for pagination Default: 0
toDate	string	Required within parent	To Date
type	string	Optional	type must be one of the following values: recent, all, scheduled, draft, failed, in_review, published, in_progress, pending and deleted Default: all

Get posts — 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 Get posts — response body — results count, posts
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: Get posts — response body — results count, posts

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

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

Get posts — response body — results / count, posts / posts / item / 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`. Known values: 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 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 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` Known values: 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 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 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: 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 end Date end Date, end Time, 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 start Date start Date, start Time

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 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 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 end Date end Date, end Time end Date day, month, year
endTime	JSON	Optional	End Time
endTime (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 end Date end Date, end Time end Time hours, minutes, seconds

Referenced models: 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 end Date end Date, end Time end Date day, month, year, 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 end Date end Date, end Time end Time hours, minutes, seconds

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 end Date end Date, end Time end Date day, month, year

Field	Type	Presence	Description and constraints
$	object	Root
day	JSON	Required within parent
day (anyOf 1)	number	Alternative	Day component of the date (1-31)
day (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
month	JSON	Required within parent
month (anyOf 1)	number	Alternative	Month component of the date (1-12)
month (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
year	JSON	Required within parent
year (anyOf 1)	number	Alternative	Year component of the date
year (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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 end Date end Date, end Time end Time hours, minutes, seconds

Field	Type	Presence	Description and constraints
$	object	Root
hours	JSON	Required within parent
hours (anyOf 1)	number	Alternative	Hour component of the time (0-23)
hours (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minutes	JSON	Required within parent
minutes (anyOf 1)	number	Alternative	Minute component of the time (0-59)
minutes (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
seconds	JSON	Required within parent
seconds (anyOf 1)	number	Alternative	Second component of the time (0-59)
seconds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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 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 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 end Date end Date, end Time end Date day, month, year
startTime	JSON	Optional	Start Time
startTime (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 end Date end Date, end Time end Time hours, minutes, seconds

Referenced models: 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 end Date end Date, end Time end Date day, month, year, 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 end Date end Date, end Time end Time hours, minutes, seconds

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

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

Get posts — response body — results / count, posts / posts / item / 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. Known values: ONE_DAY, THREE_DAYS, SEVEN_DAYS, FOURTEEN_DAYS

Get posts — response body — results / count, posts / posts / item / postApprovalDetails / approvalStatus: pending, approved, rejected, not required

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

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

Get posts — response body — results / count, posts / posts / item / 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`. Known values: 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`

Get posts — response body — results / count, posts / posts / item / 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 Known values: 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.** Known values: video, short

Get posts — response body — results count, posts

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Optional
count (anyOf 1)	number	Alternative	Total count of posts
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
posts	array	Optional	Post Data
posts[]	Model	Each item	Expand Get posts — response body — results count, posts posts item

Referenced models: Get posts — response body — results count, posts posts item

Get posts — response body — results count, posts posts item

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
blueskyPostDetails	JSON	Optional	Bluesky Post Details
blueskyPostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results count, posts posts item bluesky Post Details external Link, external Link Description, external Link Title, language, quote Post, reply To, shortened Links
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
insights	JSON	Optional	Aggregated engagement metrics for the published post. Populated asynchronously by the insights sync workers for supported platforms (Facebook, Instagram, LinkedIn, YouTube). Absent on posts that have not been synced yet or on platforms where insights are not supported.
insights (allOf 1)	Model	All variants apply	Expand Get posts — response body — results count, posts posts item insights Aggregated engagement metrics for a published post
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
platform	string	Optional	platform must be one of the following values: google, facebook, instagram, linkedin, twitter, tiktok
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
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: Get posts — response body — results count, posts posts item bluesky Post Details external Link, external Link Description, external Link Title, language, quote Post, reply To, shortened Links, 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 insights Aggregated engagement metrics for a published post, 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

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

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

Get posts — response body — results count, posts posts item insights Aggregated engagement metrics for a published post

Field	Type	Presence	Description and constraints
$	object	Root	Aggregated engagement metrics for a published post.
comment	JSON	Optional
comment (anyOf 1)	number	Alternative	Total number of comments on the post.
comment (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
like	JSON	Optional
like (anyOf 1)	number	Alternative	Total number of likes (or platform-equivalent reactions) on the post.
like (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
share	JSON	Optional
share (anyOf 1)	number	Alternative	Total number of shares/reposts of the post.
share (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get posts — response body — results count, posts posts item 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 Get posts — response body — results count, posts posts item 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: Get posts — response body — results count, posts posts item linkedin Post Details pdf Title, poll, post As Pdf poll options, question, settings

Get posts — response body — results count, posts posts item 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 Get posts — response body — results / count, posts / posts / item / 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, Get posts — response body — results / count, posts / posts / item / linkedinPostDetails / pdfTitle, poll, postAsPdf / poll / options, question, settings / settings / duration: ONE DAY, THREE DAYS, SEVEN DAYS, FOURTEEN DAYS

Get posts — response body — results count, posts posts item 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. Known values: 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.

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

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	Email Id
firstName	string	Required within parent	First name
id	string	Required within parent	User Id
lastName	string	Required within parent	Last name
phone	string	Required within parent	Phone number
profilePhoto	string	Required within parent	Profile photo
title	string	Required within parent	Title

Get scheduled posts calendar view — 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
categoryIds	array	Optional	Category Id
categoryIds[]	string	Each item
endDate	string	Required within parent	End Date in ISO format
locationId	string	Required within parent	Location ID
startDate	string	Required within parent	Start Date in ISO format

Get scheduled posts calendar view — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	Model	Required within parent	Expand Get scheduled posts calendar view — 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: Get scheduled posts calendar view — response body — results

Get scheduled posts calendar view — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional
scheduledPosts	array	Optional
scheduledPosts[]	Model	Each item	Expand Get scheduled posts calendar view — 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: Get scheduled posts calendar view — response body — results scheduled Posts item

Get scheduled posts calendar view — 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
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
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

Get tags by ids — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
tagIds	array	Required within parent	Array of Tag Ids
tagIds[]	string	Each item

Get tags by ids — 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 Get tags by ids — response body — results count, tags
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: Get tags by ids — response body — results count, tags

Get tags by ids — response body — results count, tags

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Optional
count (anyOf 1)	number	Alternative	Count
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tags	array	Required within parent	Social Media Tag Data
tags[]	Model	Each item	Expand Get tags by ids — response body — results count, tags tags item

Referenced models: Get tags by ids — response body — results count, tags tags item

Get tags by ids — response body — results count, tags tags item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	MongoDB document ID
createdAt	string	Optional	Date when the record was created Format: date-time
createdBy	string	Optional	Created By User Id
deleted	boolean	Optional	Deleted boolean value
locationId	string	Optional	Location Id
tag	string	Optional	Tag Name
updatedAt	string	Optional	Date when the record was last updated Format: date-time

Get tags by location id — 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 Get tags by location id — response body — results count, tags
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: Get tags by location id — response body — results count, tags

Get tags by location id — response body — results count, tags

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Optional
count (anyOf 1)	number	Alternative	Count
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tags	array	Optional	Tags Data
tags[]	Model	Each item	Expand Get tags by ids — response body — results count, tags tags item

Referenced models: Get tags by ids — response body — results count, tags tags item

List comments for a post or thread — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
fromDate	string	Optional	Start of the published-date window (ISO 8601). If provided, `toDate` is also required, and `fromDate` must be ≤ `toDate`. Omit both to disable date filtering.
limit	number	Optional	Pagination page size — number of comments to return. Must be between 1 and 100. Default: 10 Maximum: 100 Minimum: 1
originIds	array	Required within parent	Origin IDs of connected accounts to filter by
originIds[]	string	Each item
parentId	string	Optional	Parent ID — pass the Highlevel post ID (for replies under a specific post) or the Highlevel comment ID (for replies under a specific comment). Omit to list all top-level comments for the location filtered by `originIds`. Must be a valid 24-character Highlevel ID, not the native platform ID.
search	string	Optional	Search
skip	number	Optional	Pagination offset — number of comments to skip (zero-based). Must be ≥ 0. Default: 0 Minimum: 0
sortBy	string	Optional	Sort by top comments or latest comments Default: latest One of: top, latest
toDate	string	Optional	End of the published-date window (ISO 8601). If provided, `fromDate` is also required.

List comments for a post or thread — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Required within parent	Comments and pagination metadata
results (allOf 1)	Model	All variants apply	Expand List comments for a post or thread — response body — results comments, meta
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: List comments for a post or thread — response body — results comments, meta

List comments for a post or thread — response body — results comments, meta

Field	Type	Presence	Description and constraints
$	object	Root
comments	array	Required within parent	List of comments
comments[]	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
meta	JSON	Required within parent	Pagination metadata
meta (allOf 1)	Model	All variants apply	Expand List comments for a post or thread — response body — results comments, meta meta has More, limit, skip, total, total Unread

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, List comments for a post or thread — response body — results comments, meta meta has More, limit, skip, total, total Unread

List comments for a post or thread — response body — results comments, meta meta has More, limit, skip, total, total Unread

Field	Type	Presence	Description and constraints
$	object	Root
hasMore	boolean	Required within parent	True if more pages exist beyond this batch
limit	JSON	Required within parent
limit (anyOf 1)	number	Alternative	Pagination limit
limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
skip	JSON	Required within parent
skip (anyOf 1)	number	Alternative	Pagination skip
skip (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total comments matching the query
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalUnread	JSON	Optional
totalUnread (anyOf 1)	number	Alternative	Total unread comments matching the query
totalUnread (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Reset an item in a queue — request body — body

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

Reset an item in a queue — response body

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

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

Reset an item in a queue — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional	A message indicating the result of the operation. Examples: "Queue item reset successfully", "Dummy queue item deleted successfully".
queueItem	JSON	Optional	The reset queue item, including its current variation.
queueItem (allOf 1)	Model	All variants apply	Expand Reset an item in a queue — response body — results queue Item id, current Variation, errors, is Skipped, order, post, post Id, primary Image, scheduled Date Time, scheduled Variation Index, variations

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

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

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

Referenced models: Get posts — response body — results count, posts posts item, Fetch items from a queue — response body — results items item variations item

Save edit session changes — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
keepInDraft	boolean	Optional	If true, keeps the queue in DRAFT state after saving instead of automatically activating it. Only applicable when the queue is currently in DRAFT status. Default: false
locationId	string	Required within parent	Location ID
sessionId	string	Required within parent	Edit session ID

Save edit session changes — response body

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

Save 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.
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 all items after saving changes
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

Set Accounts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
accountIds	array	Required within parent	Account Ids
accountIds[]	string	Each item
approver	string	Optional	Approver User Id
csvFileType	string	Optional	CSV file type - determines the format of the CSV file being imported One of: basic, advance
fileName	string	Required within parent	Name of file
filePath	string	Required within parent	File path
rowsCount	number	Required within parent	Entries Count. rowsCount must be between 1 and number of posts in CSV
userId	string	Required within parent	User ID

Set Accounts — 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 Set Accounts — response body — results csv 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: Set Accounts — response body — results csv Id

Set Accounts — response body — results csv Id

Field	Type	Presence	Description and constraints
$	object	Root
csvId	string	Required within parent	CSV Id

Start CSV Finalize — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
userId	string	Required within parent	User ID

Start or resume an edit session — request body — body

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

Start or resume an edit session — response body

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

Start or resume an edit session — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
itemCount	JSON	Optional
itemCount (anyOf 1)	number	Alternative	Number of items staged for editing.
itemCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
message	string	Optional	A message indicating the result of the operation.
sessionId	string	Optional	The ID of the edit session.

Update an item in a queue — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location ID
modifiedPostPayload	JSON	Optional	Modifications to the original post
modifiedPostPayload (allOf 1)	Model	All variants apply	Expand Update an item in a queue — request body — body modified Post Payload account Ids, apply Watermark, category Id, created By, facebook Post Details, follow Up Comment, gmb Post Details, instagram Post Details, linkedin Post Details, location Id, media, og Tags Details, pinterest Post Details, post Approval Details, schedule Date, schedule Time Updated, selected Best Time, status, summary, tags, tiktok Post Details, type, user Id, youtube Post Details
newOrder	JSON	Optional	New order value or position keyword (cyclic-aware). Accepts: - A number: explicit order value calculated by FE as midpoint between adjacent items - "top": place at cyclic top (first to be scheduled next) - "bottom": place at cyclic bottom (last to be scheduled) For positions between items, FE calculates: Math.floor((prevItem.order + nextItem.order) / 2)
newOrder (oneOf 1)	number	Alternative
newOrder (oneOf 2)	string	Alternative
primaryImage	string	Optional	Primary media URL (image)
sessionId	string	Optional	Edit session ID
variations	array	Optional	Variations
variations[]	Model	Each item	Expand Update an item in a queue — request body — body variations item

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

Update an item in a queue — 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

Field	Type	Presence	Description and constraints
$	object	Root
accountIds	array	Optional	Account Ids (OAuth only)
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	Created By
facebookPostDetails	JSON	Optional	Facebook Post Details
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 Post Details
instagramPostDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body / instagramPostDetails / type: post, story, reel
linkedinPostDetails	JSON	Optional	Linkedin Post Details
linkedinPostDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body linkedin Post Details pdf Title, poll, post As Pdf
locationId	string	Optional	Location Id
media	array	Optional	Post Media
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 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 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	object	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)
summary	string	Optional	Post Content
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	object	Optional	Post Type must be one of the following values: - post, story, reel
userId	string	Optional	User ID
youtubePostDetails	JSON	Optional	Youtube Post Details
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

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

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

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

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

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