HighLevel: Save edit session changes

← Social planner operations · Get started

Operation gohighlevel.saveeditsession

Provider route: POST /social-media-posting/category/queues/{queueId}/edit/save. 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"]["saveEditSession"]>[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.saveEditSession(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.save_edit_session(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 Save edit session changes — request body — body

Referenced models: Save edit session changes — 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 Save edit session changes — response body

Referenced models: Save edit session changes — response body

Schemas

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

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

Policy, approvals and errors

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