HighLevel: Social planner schemas (part 3)

← Social planner operations · All schemas

Update an item in a queue — response body

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

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

Update an item in a queue — response body — results

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

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

Update queue settings or status — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
enableFuturePosts	boolean	Optional	Enable posting future content. Automatically Queue any New Posts Created in this Category.
locationId	string	Required within parent	Location ID
prioritizeNewContent	boolean	Optional	Prioritize new content over older content. When true, new items added via directToQueue will be placed at the top of the queue.
skipDateTime	string	Optional	Skip Date Time in ISO format
skipLegacyWatermark	boolean	Optional	Skip legacy watermark cleanup when rescheduling posts
status	object	Optional	Status of the Queue
timeSlots	array	Optional
timeSlots[]	Model	Each item	Expand Create a new category queue — request body — body time Slots item

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

Update queue settings or status — response body

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

Update queue settings or status — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional	A message indicating the result of the operation. Examples: "Queue updated successfully.", "Queue paused successfully.", "Queue activated successfully.", "Queue deleted successfully."
queue	JSON	Optional	The updated queue.
queue (allOf 1)	Model	All variants apply	Expand Update queue settings or status — response body — results / queue / status: active, paused, draft

Referenced models: Update queue settings or status — response body — results / queue / status: active, paused, draft

Update queue settings or status — response body — results / queue / status: active, paused, draft

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

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

Upload CSV — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Optional	Requested Results
results (allOf 1)	Model	All variants apply	Expand Upload CSV — response body — results / csvFileType: basic, advance
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: Upload CSV — response body — results / csvFileType: basic, advance

Upload CSV — response body — results / csvFileType: basic, advance

Field	Type	Presence	Description and constraints
$	object	Root
csvFileType	string	Optional	CSV file type Known values: basic, advance
fileName	string	Optional	Name of the uploaded file
filePath	string	Optional	File path of uploaded CSV
fileSize	JSON	Optional
fileSize (anyOf 1)	number	Alternative	Size of the file in bytes
fileSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rowsCount	JSON	Optional
rowsCount (anyOf 1)	number	Alternative	Number of rows in the CSV
rowsCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$