HighLevel: Update queue settings or status

← Social planner operations · Get started

Operation gohighlevel.updatequeue

Provider route: PUT /social-media-posting/category/queues/{queueId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["socialPlanner"]["updateQueue"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.socialPlanner.updateQueue(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.social_planner.update_queue(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.queueId	string	Required within parent
body	Model	Required within parent	Expand Update queue settings or status — request body — body

Referenced models: Update queue settings or status — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Update queue settings or status — response body

Referenced models: Update queue settings or status — response body

Schemas

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

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

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

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

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

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

Policy, approvals and errors

SDK function policy ID: gohighlevel.updatequeue. Catalog operation: updateQueue. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["socialplanner/category.write"]

Pinned headers: {"Version": "v3"}

Official provider source