Add HighLevel Location to your AI agent

Duplicate an existing Facebook campaign Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Retrieve a Facebook campaign with its linked adsets and ads Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Return the current Meta publishing step counts and completion state for a Facebook campaign. Location PITs must be provisioned with the HighLevel permission `adPublishing.readonly`; a minimal PIT without it was denied while a broad PIT passed.

Retrieve Facebook conversation lead forms for a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve a specific Facebook custom audience by its ID Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve Facebook custom audiences for a location. HighLevel returns an empty details list for an unknown ad account ID, so an empty result does not validate that account. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

List Facebook campaigns, ad sets, or ads that exist on Meta. Local HighLevel drafts are not returned. type=INTEGRATION requires selected_ad_account_id. An empty result is returned as data=[] rather than an error. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve Instagram accounts linked to a specific Facebook page Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve a specific published or draft Facebook lead form by ID. Draft IDs require is_draft=true. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve lead forms for a Facebook page. Draft IDs are returned with a draft_ prefix; pass that ID and is_draft=true to Get lead form by ID. HighLevel may return drafts even when is_draft=false. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve Facebook pages associated with the connected account Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve Facebook conversion pixels for a location. Facebook-channel results are returned under `items`; Instagram-channel results are returned under `details`. HighLevel may return the full pixel list when page_id does not match a known page, so an unfiltered result does not confirm that page exists. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Pause a published Facebook ad. Draft or otherwise unpublished ads cannot be paused. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Pause a published Facebook ad set. Draft or otherwise unpublished ad sets cannot be paused. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Pause a published Facebook campaign. Draft or otherwise unpublished campaigns cannot be paused. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Publish a Facebook campaign and push it live to Facebook Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Remove a member from a Facebook custom audience Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Resume a paused Facebook ad. The ad must already be published and paused. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Resume a paused Facebook ad set. The ad set must already be published and paused. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Resume a paused Facebook campaign. The campaign must already be published and paused. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Set the default Facebook page for a location. HighLevel does not validate page_id before returning success=true and an unknown ID can unset the real default, so verify the integration after this call. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Update name or description of a Facebook custom audience Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Create or update a Facebook ad. Creating requires a non-empty name. Each media item type must be lowercase image or video. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Create or update a Facebook ad set. Creating requires a non-empty name. Publishing every ad set requires name, pageId, audience, and budget with budgetType and amount. audience.placements must be an object keyed by platform, for example {facebook: [feed], instagram: [stream]}, not a string array. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Create or update a Facebook campaign. Creating requires a non-empty name and an objective; updates may identify the campaign by id. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Create or update a Facebook conversion pixel. Omitting conversion_pixel_id or supplying an unknown ID creates a real Meta pixel/dataset; this is not a local draft. INSTAGRAM_DM pixels cannot be updated, and an empty name is ignored by HighLevel. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Create a job to upload users to an existing Google Customer Match list. Verify user_list_id and smart_list_ids before calling: HighLevel can return success=true even when either identifier does not exist, and this action cannot verify downstream ingestion. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Soft-delete a Google Ads conversion action by ID. Google retains the resource with status REMOVED, so GET_CONVERSION_BY_ID may still return it after deletion. HighLevel may report an unknown ID as an opaque 500 rather than not-found. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Delete a Google Ads audience segment by ID. HighLevel may report an unknown ID as an opaque 500 rather than not-found. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Retrieve Google Ads creative assets for a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve a specific Google Ads combined audience by ID Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve Google Ads combined audiences for a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve a specific Google Ads campaign by ID, including its ad groups and ad content. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve a specific Google Ads conversion action by ID Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve Google Ads conversion goals for a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve Google Ads conversion actions for a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve Google-side campaigns, ad groups, or ads through the current AD_MANAGER path. HighLevel draft campaigns are not returned; retain the ID returned by UPSERT_CAMPAIGN and use GET_CAMPAIGN_BY_ID to read a draft. ADGROUP requires campaign_id, while AD requires ad_group_id or campaign_id. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve keyword suggestions for Google Ads campaigns Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve a specific Google Ads audience segment by ID Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve Google Ads audience segments for a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve affinity and in-market audience options for Google Ads targeting. IN_MARKET with SEARCH or DISPLAY exceeds the platform response-size limit (413); use another supported channel when possible. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Publish a Google ad and push it live Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Create or update Google Ads creative assets. Include resourceName to update an existing CALL or SITELINK asset. On SITELINK updates, resend description1 and description2 because HighLevel clears either omitted description. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Create or update a Google Ads combined audience. dimensions is required; a minimal live-proven value is {"genders":["FEMALE"]}. HighLevel exposes no delete endpoint for these audiences. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Create or update a full Google Ads campaign structure. HighLevel exposes no campaign delete endpoint; archive a draft by updating it with publishing_status=ARCHIVED. GET_ENTITY only lists Google-side entities and will not find HighLevel drafts, so retain the returned HighLevel id for GET_CAMPAIGN_BY_ID. HighLevel currently does not persist maximum_cpc or advanced_options. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Create or update a Google Ads conversion action. On create, Google may replace GOOGLE_ADS_LAST_CLICK with GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN; read the action back before relying on the attribution model. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Create or update a Google Ads audience segment Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Create a new LinkedIn lead gen form for an ad account Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Retrieve a LinkedIn ad campaign group by ID Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve reporting metrics for a specific LinkedIn campaign group Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Retrieve LinkedIn lead gen forms for an ad account Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Publish a LinkedIn ad campaign group and push it live Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Pause or resume a LinkedIn ad, campaign, or ad group Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Create or update a LinkedIn ad campaign group with campaigns and ads Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Retrieve a single affiliate by id for a location. Location PITs must be provisioned with the HighLevel permission: `affiliate-manager.readonly`.

Retrieve the list of affiliates for a location. Location PITs must be provisioned with the HighLevel permission: `affiliate-manager.readonly`.

Retrieve the list of commissions for a location. Location PITs must be provisioned with the HighLevel permission: `affiliate-manager.readonly`.

Retrieve the list of payouts for a location. Location PITs must be provisioned with the HighLevel permission: `affiliate-manager.readonly`.

Create an Agent Studio agent with an initial staging version. Location PITs must be provisioned with the HighLevel permission: `agent-studio.write`.

Permanently delete an Agent Studio agent and all of its versions. Location PITs must be provisioned with the HighLevel permission: `agent-studio.write`.

Execute an active Agent Studio agent and return its complete non-streaming response. Execution may invoke the agent's configured actions and cause external side effects. Location PITs must be provisioned with the HighLevel permission: `agent-studio.write`.

Get one active Agent Studio agent and all of its non-deleted versions. Location PITs must be provisioned with the HighLevel permission: `agent-studio.readonly`.

List active Agent Studio agents for the connected Location, one page at a time. Location PITs must be provisioned with the HighLevel permission: `agent-studio.readonly`.

Irreversibly promote an Agent Studio draft version to production. Location PITs must be provisioned with the HighLevel permission: `agent-studio.write`.

Update an Agent Studio agent's name, description, or status. Location PITs must be provisioned with the HighLevel permission: `agent-studio.write`.

Update a specific Agent Studio version. HighLevel's PATCH currently replaces nodes, edges, and variables with empty shells; set graphs at create time and update only version_name, description, or global_config here. Location PITs must be provisioned with the HighLevel permission: `agent-studio.write`.

Create a user-defined association between supported HighLevel object types. Location PITs must be provisioned with the HighLevel permission: `associations.write`.

Create a relation between two records in the association definition's canonical first-object then second-object order; reversing the records is invalid. Location PITs must be provisioned with the HighLevel permission: `associations/relation.write`.

Permanently delete a user-defined association. HighLevel refuses deletion while relations remain; first list them with GET_RELATIONS_BY_RECORD_ID and remove each with DELETE_RELATION. Location PITs must be provisioned with the HighLevel permission: `associations.write`.

Permanently delete one relation between associated records. Location PITs must be provisioned with the HighLevel permission: `associations/relation.write`.

Return a page of association definitions for the connected Location. Location PITs must be provisioned with the HighLevel permission: `associations.readonly`.

Get a system- or user-defined association by its ID. Location PITs must be provisioned with the HighLevel permission: `associations.readonly`.

Get association definitions for a contact, opportunity, or custom-object key. Location PITs must be provisioned with the HighLevel permission: `associations.readonly`.

Get a standard or user-defined association definition by its key name. Location PITs must be provisioned with the HighLevel permission: `associations.readonly`.

Return a page of relations for a record, optionally filtered by association IDs. Results can include HighLevel system-defined opportunity/contact relations as well as user-defined relations. Location PITs must be provisioned with the HighLevel permission: `associations/relation.readonly`.

Update the first- and second-object labels of an association definition. Location PITs must be provisioned with the HighLevel permission: `associations.write`.

Check whether a URL slug is already used by a blog post in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `blogs/check-slug.readonly`.

Create a blog post in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `blogs/post.write`.

Return one offset-based page of blog authors for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `blogs/author.readonly`.

Return one offset-based page of blog categories for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `blogs/category.readonly`.

Return one offset-based page of posts for a blog in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `blogs/posts.readonly`.

Return one offset-based page of blogs for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `blogs/list.readonly`.

Update an existing blog post in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `blogs/post-update.write`.

Create a brand board with logos, colors, and fonts in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `brand-boards/design-kit.write`.

Create a brand voice in the connected location. Location PITs require `brand-boards/voices.write`.

Delete a brand board from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `brand-boards/design-kit.write`.

Delete a brand voice after explicit confirmation. Location PITs require `brand-boards/voices.write`.

Retrieve one brand board by ID from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `brand-boards/design-kit.readonly`.

Return one page of brand boards for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `brand-boards/design-kit.readonly`.

Get a brand voice from the connected location. Location PITs require `brand-boards/voices.readonly`.

Return one page of brand voices for the connected location. Location PITs require `brand-boards/voices.readonly`.

Set the location's default brand voice, replacing the previous default, after explicit confirmation. Location PITs require `brand-boards/voices.write`.

Update an existing brand board in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `brand-boards/design-kit.write`.

Update a brand voice after explicit confirmation. Location PITs require `brand-boards/voices.write`.

Create a business in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `businesses.write`.

Permanently delete a business by ID. Location PITs must be provisioned with the HighLevel permission: `businesses.write`.

Retrieve one business by ID. Location PITs must be provisioned with the HighLevel permission: `businesses.readonly`.

Return one offset-paginated page of businesses for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `businesses.readonly`.

Update editable details of an existing business by ID. Location PITs must be provisioned with the HighLevel permission: `businesses.write`.

Associate a calendar with a schedule. HighLevel may create an unnamed cloned schedule while changing the association. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Create an appointment. Recurring appointments and calls with ignore_free_slot_validation require assigned_user_id. Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Create an appointment note. HighLevel can store the note and then return an error for an invalid user_id, so use a verified user ID or omit it rather than retrying blindly. Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Create a block slot for exactly one owner: assigned_user_id or calendar_id. Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Create calendar in a location. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Create Calendar Group Location PITs must be provisioned with the HighLevel permission: `calendars/groups.write`.

Create calendar resource by resource type (Services V1) Location PITs must be provisioned with the HighLevel permission: `calendars/resources.write`.

Create or replace the availability schedule for an event calendar. This endpoint is an upsert: an existing schedule's rules and timezone are replaced. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Create Calendar notifications, either one or multiple. All notification settings must be for single calendar only Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Create new schedule with specified rules, timezone, location, user and calendar associations. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Create a new service booking Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Create new service in a location. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Create a new service location Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Delete Note Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Delete calendar by ID Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Delete calendar resource by ID (Services V1) Location PITs must be provisioned with the HighLevel permission: `calendars/resources.write`.

Delete event by ID Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Delete notification Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Delete Group Location PITs must be provisioned with the HighLevel permission: `calendars/groups.write`.

Permanently remove a schedule and all its associated rules. This action cannot be undone. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Delete a service booking by ID Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Delete a service catalog item by ID. HighLevel soft-deletes the item: list operations exclude it, but a direct lookup by ID may still return it. Repeated deletion may also report success. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Delete a service location by ID Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Disable Group Location PITs must be provisioned with the HighLevel permission: `calendars/groups.write`.

Update appointment Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Update block slot by ID Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Update Group by group ID Location PITs must be provisioned with the HighLevel permission: `calendars/groups.write`.

List calendar resources by resource type and location ID (Services V1) Location PITs must be provisioned with the HighLevel permission: `calendars/resources.readonly`.

Find Event notification by notificationId Location PITs must be provisioned with the HighLevel permission: `calendars/events.readonly`.

Retrieve user availability schedules based on various filters including location, calendar, and user. Supports pagination. Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.

Get appointment by ID Location PITs must be provisioned with the HighLevel permission: `calendars/events.readonly`.

Get Appointment Notes Location PITs must be provisioned with the HighLevel permission: `calendars/events.readonly`.

Get blocked slots for exactly one owner: user_id, calendar_id, or group_id. Location PITs must be provisioned with the HighLevel permission: `calendars/events.readonly`.

Get calendar by ID Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.

Get calendar events for exactly one owner: user_id, calendar_id, or group_id. Location PITs must be provisioned with the HighLevel permission: `calendars/events.readonly`.

Get calendar resource by ID (Services V1) Location PITs must be provisioned with the HighLevel permission: `calendars/resources.readonly`.

Retrieve the availability schedule for a specific event calendar. Returns the schedule associated with the calendar ID provided in the path. Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.

Get all calendars in a location. Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.

Get calendar notifications. When deleted is omitted, HighLevel can include soft-deleted notification settings; set deleted explicitly when filtering by deletion state. Location PITs must be provisioned with the HighLevel permission: `calendars/events.readonly`.

Get all calendar groups in a location. Location PITs must be provisioned with the HighLevel permission: `calendars/groups.readonly`.

Retrieve a specific schedule by its unique identifier. Returns detailed information including rules, timezone, and associated calendars/users. Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.

Get a specific service booking by ID Location PITs must be provisioned with the HighLevel permission: `calendars/events.readonly`.

Retrieve service bookings for a location within a given date range, with an optional service location filter. Location PITs must be provisioned with the HighLevel permission: `calendars/events.readonly`.

Get service by ID. Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.

Get service location by ID Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.

Get all service locations Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.

Get all services in a location. Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.

Get free slots for a calendar between a date range. Optionally a consumer can also request free slots in a particular timezone and also for a particular user. Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.

Remove a calendar from a schedule. HighLevel may leave an unnamed cloned schedule after changing the association. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Update Note Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Update calendar by ID. HighLevel resets omitted slot duration, slot interval, form submit type, availability, notifications, and open hours to provider defaults, so resend those settings when they must be preserved. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Update calendar resource by ID (Services V1) Location PITs must be provisioned with the HighLevel permission: `calendars/resources.write`.

Update the availability schedule for a specific event calendar. Only provided fields will be updated. The calendar ID is provided in the path. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Update Event notification by id Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Modify an existing schedule by updating its rules, timezone, and name All fields are optional - only provided fields will be updated. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Update an existing service booking. For an ask_booker service location, every update must resend meeting_location. Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.

Update service by ID. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Update an existing service location Location PITs must be provisioned with the HighLevel permission: `calendars.write`.

Validate if group slug is available or not. Location PITs must be provisioned with the HighLevel permission: `calendars/groups.write`.

Return campaigns for the connected HighLevel location, optionally filtered by status. Location PITs must be provisioned with the HighLevel permission: `campaigns.readonly`.

Creates a copy of a chat widget in the connected sub-account. Location PITs must be provisioned with the HighLevel permission: `chat-widget.write`.

Creates a new chat widget for the connected sub-account. Location PITs must be provisioned with the HighLevel permission: `chat-widget.write`.

Soft-deletes a chat widget from the connected sub-account. Location PITs must be provisioned with the HighLevel permission: `chat-widget.write`.

Returns a single chat widget by ID from the connected sub-account. Location PITs must be provisioned with the HighLevel permission: `chat-widget.readonly`.

Return a chat widget's public configuration by widget ID. No endpoint-specific provider permission was evidenced beyond a valid Location token.

Returns chat widgets for the connected sub-account with pagination and optional filters. Location PITs must be provisioned with the HighLevel permission: `chat-widget.readonly`.

Partially updates a chat widget in the connected sub-account. Location PITs must be provisioned with the HighLevel permission: `chat-widget.write`.

Fully updates a chat widget in the connected sub-account. Preserve existing values, including settings, that should remain after this replacement. Location PITs must be provisioned with the HighLevel permission: `chat-widget.write`.

Add contact to Campaign Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Add Contact to Workflow Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Add Followers Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Add Tags Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Submit a job to assign one business to up to 50 contacts, or remove their business association with `remove_business=true`. HighLevel does not validate each contact ID before returning `success:true`, so that response means only that the job was accepted; verify important effects by reading the contacts. Confirm the contact IDs and intended association change before calling. No Contacts-specific PIT permission was enforced by the completed minimal-PIT probe.

Add or remove tags for multiple contacts, including optionally removing all tags. The action fails when HighLevel reports any contact-level error, even if the HTTP response says success. Confirm the operation type, contacts, and tags before calling. No Contacts-specific PIT permission was enforced by the completed minimal-PIT probe.

Create a new contact Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Create Note Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Create Task Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Delete Contact Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Delete Contact from Workflow Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Delete Note Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Delete Task Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Get All Notes Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.

Get all Tasks Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.

Get Appointments for Contact Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.

Retrieves a contact by its unique identifier. Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.

Get Contacts By BusinessId Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.

Get Duplicate Contact. If `Allow Duplicate Contact` is disabled under Settings, the global unique identifier will be used for searching the contact. If the setting is enabled, first priority for search is `email` and the second priority will be `phone`. Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.

Get Note Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.

Get Task Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.

Remove Contact From Campaign Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Removes the contact from every campaign it is enrolled in. Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Remove Followers Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Remove Tags Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Search contacts using advanced filters and return one cursor-controlled page. Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.

Update a contact using contactId Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Update Note Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Update Task Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Update Task Completed Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

The Upsert API will adhere to the configuration defined under the "Allow Duplicate Contact" setting at the Location level. If the setting is configured to check both Email and Phone, the API will attempt to identify an existing contact based on the priority sequence specified in the setting, and will create or update the contact accordingly. If two separate contacts already exist—one with the same email and another with the same phone—and an upsert request includes both the email and phone, the API will update the contact that matches the first field in the configured sequence, and ignore the second field to prevent duplication. Location PITs must be provisioned with the HighLevel permission: `contacts.write`.

Creates and attach a new action for an AI agent. Actions define specific tasks or behaviors that the agent can perform, such as booking appointments, sending follow-ups, or collecting information. Location PITs must be provisioned with the HighLevel permission: `conversation-ai.write`. Explicit confirmation is required before this mutation is sent.

Creates a new AI agent for the location. The agent will be created with the specified configuration including name, role, actions, and behavior settings. Location PITs must be provisioned with the HighLevel permission: `conversation-ai.write`. Explicit confirmation is required before this mutation is sent.

Permanently deletes an action. This will remove the action from all associated agents and cannot be undone. Location PITs must be provisioned with the HighLevel permission: `conversation-ai.write`. Explicit confirmation is required before this mutation is sent.

Deletes an AI agent permanently. This action cannot be undone. All associated configurations and conversation history will be removed. Location PITs must be provisioned with the HighLevel permission: `conversation-ai.write`. Explicit confirmation is required before this mutation is sent.

Retrieves detailed information about a specific action using its unique identifier. Returns the action configuration, associated agents, and performance metrics. Location PITs must be provisioned with the HighLevel permission: `conversation-ai.readonly`.

Retrieves a specific AI agent by its ID. Returns the complete agent configuration including name, status, actions, and settings. Location PITs must be provisioned with the HighLevel permission: `conversation-ai.readonly`.

Retrieves detailed information about AI responses including the System Prompt, Conversation history, Knowledge base, website, FAQ chunks, and Rich Text chunks. Location PITs must be provisioned with the HighLevel permission: `conversation-ai.readonly`.

List for actions for an agent Location PITs must be provisioned with the HighLevel permission: `conversation-ai.readonly`.

Search AI agents by lowercase name query. The response has no has_more flag: omit start_after on the first page, then pass the last agent ID from the previous page and stop when count is 0. Location PITs must be provisioned with the HighLevel permission: `conversation-ai.readonly`.

Updates an existing action's configuration. This includes modifying the action name, description, trigger conditions, and behavior settings. Location PITs must be provisioned with the HighLevel permission: `conversation-ai.write`. Explicit confirmation is required before this mutation is sent.

Fully replace the required personality, goal, and instructions of an existing AI agent; omitted optional fields keep their current values. Location PITs must be provisioned with the HighLevel permission: `conversation-ai.write`. Explicit confirmation is required before this mutation is sent.

Update followupSettings for one or more advancedFollowup actions. HighLevel may retain omitted settings, so send every desired setting when deterministic replacement is required. HighLevel rejects IDs belonging to other action types. Location PITs must be provisioned with the HighLevel permission: `conversation-ai.write`. Explicit confirmation is required before this mutation is sent.

Post the necessary fields for the API to add a new inbound message. Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.

Post the necessary fields for the API to add a new outbound call. Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.

Set attachments on an existing message (replaces existing). Maximum 5 URLs. Supported for TYPE_CUSTOM_CALL (34) and TYPE_CALL (1) with subType EXTERNAL_CALL. Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.

Post the messageId for the API to delete a scheduled email message. Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.

Post the messageId for the API to delete a scheduled message. Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.

Creates a new conversation with the data provided Location PITs must be provisioned with the HighLevel permission: `conversations.write`.

Delete the conversation details based on the conversation ID Location PITs must be provisioned with the HighLevel permission: `conversations.write`.

Download the recording transcription for a message by passing the message id Location PITs must be provisioned with the HighLevel permission: `conversations/message.readonly`.

Return one page of messages for the connected HighLevel location, with a cursor for continuation. Location PITs must be provisioned with the HighLevel permission: `conversations/message.readonly`.

Get the conversation details based on the conversation ID Location PITs must be provisioned with the HighLevel permission: `conversations.readonly`.

Get email by Id Location PITs must be provisioned with the HighLevel permission: `conversations/message.readonly`.

Get message by message id. Location PITs must be provisioned with the HighLevel permission: `conversations/message.readonly`.

Get the recording for a message by passing the message id Location PITs must be provisioned with the HighLevel permission: `conversations/message.readonly`.

Get the recording transcription for a message by passing the message id Location PITs must be provisioned with the HighLevel permission: `conversations/message.readonly`.

Get messages by conversation id. Location PITs must be provisioned with the HighLevel permission: `conversations/message.readonly`.

Set the typing indicator for a conversation started by a live-chat widget visitor. This does not work for ordinary SMS, email, or other non-widget conversations; visitor_id must be that live-chat visitor's ID. Location PITs must be provisioned with the HighLevel permission: `conversations/livechat.write`.

Return one page of conversations for the connected HighLevel location and an opaque cursor for the next page. Location PITs must be provisioned with the HighLevel permission: `conversations.readonly`.

Send an external message to a contact through the selected channel. This has an irreversible external side effect and may notify or charge the recipient; verify the contact, channel, content, sender, and scheduled time before calling. Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.

Update the conversation details based on the conversation ID Location PITs must be provisioned with the HighLevel permission: `conversations.write`.

Update delivery events, per-recipient statuses, and the overall message status for an email sent via a custom conversation provider. ### Authorization - Requires the `conversations/message.write` OAuth scope. - The calling OAuth app must own the conversation provider that originally sent the email. - Attempts to update emails sent via LC Email or Mailgun will return `403 Forbidden`. ### Updatable Fields **`status`** is required on every request. You may also include **`events`** and/or **`recipients`**. **`events`** — Aggregate delivery event counters (integers). Counters are merged into the existing values (not replaced). Setting a counter to `0` is treated as no-op and will **not** reset the stored value. **`recipients`** — Per-recipient delivery statuses. Each entry maps a recipient email address to a `MessageStatus` value. Use `failReason` to capture bounce or rejection... Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.

Post the necessary fields for the API to update message status. Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.

Post the necessary fields for the API to upload files. The files need to be a buffer with the key "fileAttachment". The allowed file types are: <ul><li>JPG</li><li>JPEG</li><li>PNG</li><li>MP4</li><li>MPEG</li><li>ZIP</li><li>RAR</li><li>PDF</li><li>DOC</li><li>DOCX</li><li>TXT</li><li>MP3</li><li>WAV</li></ul> The API will return an object with the URLs Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.

Import course products into the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `courses.write`.

Connect one supported ad platform to the Location using the provider-specific account identifiers. This changes the Location's active advertising integration and can replace or disrupt an existing connection; confirm the Location, platform, ad account, and MCC before calling. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Create a custom field for a custom object or Company (Business) object in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.

Create a custom field folder for a custom object in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.

Permanently delete a custom field by ID. HighLevel currently supports custom objects and Company (Business) objects for this operation. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.

Permanently delete a custom field folder from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.

Get a custom field or folder by ID. HighLevel currently supports custom objects and Company (Business) objects for this operation. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.readonly`.

List custom fields and folders for an object key in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.readonly`.

Update a custom field by ID in the connected HighLevel location. HighLevel currently supports custom objects and Company (Business) objects. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.

Rename a custom field folder in the connected HighLevel location. HighLevel currently supports custom objects and Company (Business) objects. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.

Disconnect an ad account from one supported ad platform. This does not delete the upstream ad account, but it disables Location workflows that depend on the connection; confirm the Location, platform, and account ID before calling. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.

Verify an email address or a HighLevel contact's email. This may irreversibly deduct verification charges from the connected location or company wallet, and verification must be configured for that location. Location PITs must be provisioned with the HighLevel permission: `lc-email.readonly`.

Create an email campaign draft without scheduling or sending it. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.write`.

Create a new email template in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.write`.

Create an email-template folder in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.write`.

Delete an email campaign. For a scheduled campaign, the first call cancels its schedule; call again only if the campaign should then be permanently deleted. Verify the campaign ID before calling. Location PITs must be provisioned with `emails/campaigns.write`.

Permanently delete one email template from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.write`.

Get one bulk-action campaign from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.readonly`.

Get statistics for an email, workflow, or bulk-action campaign. Location PITs must be provisioned with the HighLevel permission: `emails/stats.readonly`.

Get one email campaign from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.readonly`.

Get one email template from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.readonly`.

Get one workflow campaign from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.readonly`.

Import an email template from a supported provider URL into the connected location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.write`.

Return one page of bulk-action campaigns for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.readonly`.

Return one page of email campaigns for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.readonly`.

Return one page of email templates and folders for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.readonly`.

Return one page of workflow campaigns for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.readonly`.

Start or schedule a draft or paused email campaign after validating recipients and schedule configuration. A cancelled campaign cannot be rescheduled; create a new draft. This can irreversibly send email to external recipients. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.write`.

Update selected fields of an email campaign draft; this action never schedules or sends it. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.write`.

Update selected fields of an email template in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.write`.

Get metadata and a short-lived signed download URL for a HighLevel file share slug. The documented response is JSON; this action does not follow the uncredentialed asset URL or forward provider credentials to its dynamic origin. Location PITs must have `files.readonly`.

Return one offset-based page of forms for the connected HighLevel location. Pass `next_cursor` back as `skip` to retrieve the next page. Location PITs must be provisioned with the HighLevel permission: `forms.readonly`.

Return one page of form submissions for the connected HighLevel location. Pass `next_cursor` back as `page` to retrieve the next page. Location PITs must be provisioned with the HighLevel permission: `forms.readonly`.

Upload one or more files to file-upload custom fields on a contact in the connected HighLevel location. Each file may be up to 50 MB. Location PITs must be provisioned with the HighLevel permission: `forms.write`.

Create a URL redirect for the connected HighLevel Location. The source domain must already be connected to the location. Location PITs must be provisioned with the HighLevel permission: `funnels/redirect.write`.

Permanently delete a URL redirect from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `funnels/redirect.write`.

Return one offset-based page of URL redirects for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `funnels/redirect.readonly`.

Return one offset-based page of funnels for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `funnels/funnel.readonly`.

Return one offset-based page of pages belonging to a HighLevel funnel. Location PITs must be provisioned with the HighLevel permission: `funnels/page.readonly`.

Count pages belonging to a HighLevel funnel, optionally filtered by name. Location PITs must be provisioned with the HighLevel permission: `funnels/pagecount.readonly`.

Update the destination and action of an existing HighLevel URL redirect. Location PITs must be provisioned with the HighLevel permission: `funnels/redirect.write`.

Return one ad account or the selected account details for one ad platform. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Return reporting metrics for one Facebook or Google ad campaign. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Return the Location's integration state for one ad platform. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Return the current user from one connected ad platform. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Return aggregate reporting metrics for one connected ad platform. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

API to manage auto payment for a schedule. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This may charge the contact's configured payment method. This may create, change, or cancel future billing activity. Location PITs must be provisioned with the HighLevel permission: `invoices/schedule.write`.

API to cancel a scheduled invoice by schedule id. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This may create, change, or cancel future billing activity. This destructive change may be irreversible; confirm the target ID and intended outcome first. Location PITs must be provisioned with the HighLevel permission: `invoices/schedule.write`.

Create a new estimate template. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.write`.

API to create an invoice. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: `invoices.write`.

Create a new invoice from an existing estimate. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.write`.

API to create an invoice Schedule. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This may create, change, or cancel future billing activity. Location PITs must be provisioned with the HighLevel permission: `invoices/schedule.write`.

Create an invoice template. HighLevel stores internal=true as false and drops items[].type. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: `invoices/template.write`.

Create a new estimate. send_estimate_details.estimateName overwrites name; sent_to and user_id are not stored until the estimate is sent. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.write`.

Delete an existing estimate. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This destructive change may be irreversible; confirm the target ID and intended outcome first. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.write`.

Delete an existing estimate template. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This destructive change may be irreversible; confirm the target ID and intended outcome first. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.write`.

Permanently delete a draft invoice by ID. HighLevel rejects deletion after the invoice leaves `draft`. Confirm the target ID and intended outcome first. Location PITs must be provisioned with the HighLevel permission: `invoices.write`.

API to delete an schedule by schedule id. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This may create, change, or cancel future billing activity. This destructive change may be irreversible; confirm the target ID and intended outcome first. Location PITs must be provisioned with the HighLevel permission: `invoices/schedule.write`.

Permanently delete an invoice template by ID. Confirm the target template before calling because this destructive change may be irreversible. Location PITs must be provisioned with `invoices/template.write`.

Get the next estimate number for the given location. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.readonly`.

Get the next invoice number for the given location. Location PITs must be provisioned with the HighLevel permission: `invoices.readonly`.

Get an invoice by ID. HighLevel returns not found for voided invoices even though LIST_INVOICES can still return them with `status=void`. Location PITs must be provisioned with the HighLevel permission: `invoices.readonly`.

API to get an schedule by schedule id. Location PITs must be provisioned with the HighLevel permission: `invoices/schedule.readonly`.

Get the invoice settings for the given location. Location PITs must be provisioned with the HighLevel permission: `invoices.readonly`.

API to get an template by template id. Location PITs must be provisioned with the HighLevel permission: `invoices/template.readonly`.

Get a list of estimate templates or a specific template by ID. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.readonly`.

Get a paginated list of estimates. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.readonly`.

API to get list of schedules. Location PITs must be provisioned with the HighLevel permission: `invoices/schedule.readonly`.

API to get list of templates. Location PITs must be provisioned with the HighLevel permission: `invoices/template.readonly`.

API to get list of invoices. Location PITs must be provisioned with the HighLevel permission: `invoices.readonly`.

Get a preview of an estimate template. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.readonly`.

Record a manual payment against an invoice. Omit amount to record the full remaining balance; payment-plan invoices accept only scheduled step amounts. This irreversibly changes the invoice's financial balance; verify the invoice, amount, method, and payment schedule before calling. Location PITs must be provisioned with the HighLevel permission: `invoices.write`.

API to schedule an schedule invoice to start sending to the customer. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This may create, change, or cancel future billing activity. Location PITs must be provisioned with the HighLevel permission: `invoices/schedule.write`.

API to send estimate by estimate id. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This sends a customer-facing payment or billing communication. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.write`.

API to send invoice by invoice id. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This sends a customer-facing payment or billing communication. Location PITs must be provisioned with the HighLevel permission: `invoices.write`.

Create or update a text-to-pay invoice. HighLevel ignores `title` and `terms_notes`, as well as attachments, tips_configuration, late_fees_configuration, payment_schedule, invoice_number_prefix, and sent_to for this operation. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record and sends a customer-facing billing communication. Location PITs must be provisioned with the HighLevel permission: `invoices.write`.

Replace the contents of an invoice schedule that is already in `scheduled` state; call SCHEDULE_INVOICE_SCHEDULE first for a draft. The request is a full replacement, so include every existing invoice, schedule, and auto-payment setting that must be preserved; omitting tipsConfiguration, paymentMethods, or automaticTaxesEnabled clears it. Review currency, amounts, taxes, discounts, fees, and payment settings because this changes future billing activity and may charge the contact. Location PITs must be provisioned with the HighLevel permission: `invoices/schedule.write`.

Update an existing estimate. Omitted terms_notes, payment_schedule_config, automatic_taxes_enabled, and live_mode are cleared. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.write`.

Update an estimate's last-visited timestamp by estimate ID. The estimate must already be in the sent state. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.write`.

Update an existing estimate template. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.write`.

Update an invoice by invoice ID. Omitting payment_schedule clears the stored payment schedule. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: `invoices.write`.

Mark an invoice as last visited in the connected Location. Location PITs must be provisioned with the HighLevel permission: `invoices.write`.

Replace late-fee settings on an invoice in the connected Location. Confirm the amount, type, frequency, grace period, and cap before changing this financial record. Location PITs must be provisioned with the HighLevel permission: `invoices.write`.

Replace an invoice schedule by schedule ID. The request is a full replacement, so include every existing invoice and schedule setting that must be preserved; omitting tipsConfiguration, paymentMethods, or automaticTaxesEnabled clears it. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record and future billing activity. Location PITs must be provisioned with the HighLevel permission: `invoices/schedule.write`.

Update an invoice template by ID. HighLevel nulls attachments, tipsConfiguration, paymentMethods, and automaticTaxesEnabled on every update, even when they are sent. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: `invoices/template.write`.

Replace an invoice template's late-fee configuration in the connected Location. Confirm the fee amount, type, frequency, grace period, and cap before calling. Location PITs must be provisioned with the HighLevel permission: `invoices.write`.

Replace payment-method settings on an invoice template in the connected Location. Confirm the intended bank-debit behavior before calling. Location PITs must be provisioned with the HighLevel permission: `invoices.write`.

Void a non-draft invoice by ID without deleting its record. Draft invoices cannot be voided, and any paid amount must be refunded before voiding. Confirm the intended accounting outcome because this financial change is irreversible. Location PITs must be provisioned with `invoices.write`.

Create an FAQ after explicit confirmation. Location PITs require `knowledge-bases.write`.

Create a knowledge base after explicit confirmation. Location PITs require `knowledge-bases.write`.

Idempotently delete an FAQ after explicit confirmation; deleting an already-deleted FAQ is treated as successful. Location PITs require `knowledge-bases.write`.

Delete a knowledge base after explicit confirmation. Location PITs require `knowledge-bases.write`.

Idempotently delete trained pages after explicit confirmation; repeated deletion may still report a positive deletedCount. Location PITs require `knowledge-bases.write`.

Start website discovery after explicit confirmation. Location PITs require `knowledge-bases.write`.

Return one page of crawled website URLs. Location PITs require `knowledge-bases.readonly`.

Get crawler operation status. Location PITs require `knowledge-bases.readonly`.

Get a knowledge base by ID. Location PITs require `knowledge-bases.readonly`.

Return one page of knowledge bases for the connected location. Location PITs require `knowledge-bases.readonly`.

Return one page of FAQs. Location PITs require `knowledge-bases.readonly`.

Queue discovered pages for training after explicit confirmation. A successful response confirms queue acceptance, not that the URL IDs existed or training completed; poll crawler status to verify progress. Location PITs require `knowledge-bases.write`.

Update an FAQ after explicit confirmation. Location PITs require `knowledge-bases.write`.

Update a knowledge base after explicit confirmation. Location PITs require `knowledge-bases.write`.

Create a trigger link in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `links.write`.

Permanently delete a trigger link by ID. Location PITs must be provisioned with the HighLevel permission: `links.write`.

Get a single trigger link by ID from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `links.readonly`.

Get all trigger links in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `links.readonly`.

Return one offset-based page of trigger links matching a search query. Location PITs must be provisioned with the HighLevel permission: `links.readonly`.

Update a trigger link's name and redirect destination. Location PITs must be provisioned with the HighLevel permission: `links.write`.

List ad accounts available through one connected ad platform. Facebook supports type, fetch_all, and cursor-based next; type=AD_MANAGER filters to the account used by HighLevel Ad Manager. limit is not exposed because HighLevel ignores it. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

List published reporting entities for one connected ad platform. Facebook drafts are not returned; use Get campaign with linked entities for a HighLevel draft. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Create a custom field in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.

Create a custom value in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customValues.write`.

Create Recurring Task Location PITs must be provisioned with the HighLevel permission: `recurring-tasks.write`. Explicit confirmation is required before this mutation is sent.

Create a tag in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/tags.write`.

Delete a custom field from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.

Delete a custom value from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customValues.write`.

Delete Recurring Task Location PITs must be provisioned with the HighLevel permission: `recurring-tasks.write`. Explicit confirmation is required before this mutation is sent.

Delete a tag from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/tags.write`.

Return one offset-based page of templates from the connected HighLevel Location. Pass next_cursor back as cursor to retrieve the next page. Location PITs must be provisioned with the HighLevel permission: `locations/templates.readonly`.

Get SMS or email channel providers configured for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations.readonly`.

Get one custom field from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.readonly`.

List custom fields owned by the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.readonly`.

Get one custom value from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customValues.readonly`.

List custom values owned by the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customValues.readonly`.

Get the Location bound to the connected HighLevel account. Location PITs must be provisioned with the HighLevel permission: `locations.readonly`.

List tags owned by the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/tags.readonly`.

Get Recurring Task By Id Location PITs must be provisioned with the HighLevel permission: `recurring-tasks.readonly`.

Get one tag from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/tags.readonly`.

Fetch the available timezones for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations.readonly`.

Return one offset-based page of tasks from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/tasks.readonly`.

Update a custom field in the connected HighLevel Location. HighLevel fully replaces placeholder, accepted_format, and text_box_list_options, so resend those values when they must be preserved. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.

Update a custom value in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customValues.write`.

Update Recurring Task Location PITs must be provisioned with the HighLevel permission: `recurring-tasks.write`. Explicit confirmation is required before this mutation is sent.

Rename a tag in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/tags.write`.

Upload a file to a custom field for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.

Check whether the connected HighLevel sub-account has sufficient wallet funds to be charged.

Create a real wallet charge for the connected HighLevel Location. The Location and its parent Company are resolved from the OAuth connection, and explicit confirmation is required.

Delete a wallet charge. This is a destructive billing operation with real wallet consequences and requires explicit confirmation.

Get company, Location, user, and installation details associated with the current HighLevel OAuth token for an app.

Get the details of one HighLevel wallet charge by charge ID.

Return one page of wallet charges visible to the connected HighLevel Location, with optional billing and date filters.

Uninstall an application from the connected HighLevel Location. This removes the application's access and stops its functionality, so explicit confirmation is required.

Delete or trash multiple files and folders in the connected Location. Explicit confirmation is required; verify every target ID and the requested state first. Location PITs must be provisioned with the HighLevel permission: `medias.write`.

Rename multiple files or folders in the connected Location's media storage. Review every target ID and name before calling. Location PITs must be provisioned with the HighLevel permission: `medias.write`.

Create a folder in the connected Location's media storage. Location PITs must be provisioned with the HighLevel permission: `medias.write`.

Delete a file or folder from the connected HighLevel location's media storage. Location PITs must be provisioned with the HighLevel permission: `medias.write`.

Fetch files and folders from the connected HighLevel location's media storage. Location PITs must be provisioned with the HighLevel permission: `medias.readonly`.

Rename one file or folder in the connected Location's media storage. Location PITs must be provisioned with the HighLevel permission: `medias.write`.

Upload a file or import a hosted file into HighLevel media storage. Location PITs must be provisioned with the HighLevel permission: `medias.write`.

Create a business or custom object record with schema-defined fields. Location PITs must be provisioned with the HighLevel permission: `objects/record.write`.

Permanently delete a business or custom object record by ID. Location PITs must be provisioned with the HighLevel permission: `objects/record.write`.

List standard and custom object schemas for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `objects/schema.readonly`.

Retrieve an object schema by key or ID, optionally including its fields. Location PITs must be provisioned with the HighLevel permission: `objects/schema.readonly`.

Retrieve a business or custom object record by ID. Location PITs must be provisioned with the HighLevel permission: `objects/record.readonly`.

Return one page of business or custom object records matching a search expression. Location PITs must be provisioned with the HighLevel permission: `objects/record.readonly`.

Update a custom object's labels, description, and searchable fields, or update searchable fields for a standard object. Custom object keys must include the `custom_objects.` prefix. `searchable_properties` replaces the complete searchable-field list. Location PITs must be provisioned with the HighLevel permission: `objects/schema.write`.

Update a standard or custom object record with schema-defined fields. Custom object schema keys include the `custom_objects.` prefix. Location PITs must be provisioned with the HighLevel permission: `objects/record.write`.

Add up to 10 user IDs as followers of an opportunity and return the resulting follower list. HighLevel may report an unknown user as `followersAdded:[[]]`; verify the resulting `followers` list when user IDs are not known-valid. Location PITs must be provisioned with the HighLevel permission: `opportunities.write`.

Create an opportunity. HighLevel rejects a duplicate opportunity for the same contact in the same pipeline. Location PITs must be provisioned with the HighLevel permission: `opportunities.write`.

Create a pipeline with at least one stage in the connected HighLevel location. Pipeline and stage names must be unique. Explicit confirmation is required. Location PITs must have `pipelines.create`.

Delete Opportunity. This destructive change may be irreversible; confirm the target ID and intended outcome first. Location PITs must be provisioned with the HighLevel permission: `opportunities.write`.

Permanently delete a pipeline and every opportunity in all its stages. This is irreversible and requires explicit confirmation. Location PITs must have `pipelines.write`.

Get lost reason. Location PITs must be provisioned with the HighLevel permission: `opportunities.readonly`.

Get Opportunity. Location PITs must be provisioned with the HighLevel permission: `opportunities.readonly`.

Retrieve one pipeline, including its stages and configuration. Location PITs must have `pipelines.readonly`.

Get Pipelines. Location PITs must be provisioned with the HighLevel permission: `opportunities.readonly`.

Allows removal of one or all followers from an opportunity. Location PITs must be provisioned with the HighLevel permission: `opportunities.write`.

Search opportunities based on combinations of advanced filters. Location PITs must be provisioned with the HighLevel permission: `opportunities.readonly`.

Search Opportunity. Location PITs must be provisioned with the HighLevel permission: `opportunities.readonly`.

Update Opportunity. Location PITs must be provisioned with the HighLevel permission: `opportunities.write`.

Update Opportunity Status. Location PITs must be provisioned with the HighLevel permission: `opportunities.write`.

Update a pipeline. The stage list is a full replacement and removing stages migrates their opportunities, so explicit confirmation is required. Location PITs must have `pipelines.write`.

Upsert Opportunity. Location PITs must be provisioned with the HighLevel permission: `opportunities.write`.

Create a promotional coupon. applyToFuturePaymentsConfig is ignored unless applyToFuturePayments is true. Review discount type and value, eligible products, dates, usage limits, and future subscription effects before calling. Location PITs must be provisioned with the HighLevel permission: `payments/coupons.write`.

Create a custom payment-provider association for the connected Location. Review all external URLs and subscription support before creating financial infrastructure. Location PITs must be provisioned with the HighLevel permission: `payments/custom-provider.write`.

Create a Location payment-provider integration backed by Authorize.net or NMI. Review the provider, public URLs, and Location before creating financial infrastructure. Location PITs must be provisioned with the HighLevel permission: `payments/integration.write`.

Create fulfillment history for an order. Confirm order, item quantities, tracking data, and whether a customer notification should be sent before calling. Location PITs must be provisioned with the HighLevel permission: `payments/orders.write`.

Set whether the connected Location's custom payment provider supports subscription schedules. Confirm downstream recurring-billing behavior before disabling support. Location PITs must be provisioned with the HighLevel permission: `payments/custom-provider.write`.

Permanently delete a coupon. This cannot be undone; confirm the exact coupon ID and that no active promotion should continue before calling. Location PITs must be provisioned with the HighLevel permission: `payments/coupons.write`.

Permanently delete the connected Location's custom payment-provider association. If no provider is configured, HighLevel may return no error detail and the action reports that explicit empty state. This can stop payment processing; confirm the Location and migration or shutdown plan before calling. Location PITs must be provisioned with the HighLevel permission: `payments/custom-provider.write`.

Disconnect a custom provider's live or test payment configuration. Disconnecting live mode can stop charges and subscriptions; confirm the Location, mode, and operational impact before calling. Location PITs must be provisioned with the HighLevel permission: `payments/custom-provider.write`.

Fetch the custom payment-provider configuration for the connected Location. A traceId-only response means no custom provider is configured. Location PITs must be provisioned with the HighLevel permission: `payments/custom-provider.readonly`.

Retrieve coupon details by ID for the connected Location. The endpoint requires `code`, but HighLevel currently ignores it when selecting the coupon. Location PITs must be provisioned with the HighLevel permission: `payments/coupons.readonly`.

Retrieve one order by ID from the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/orders.readonly`.

Retrieve one payment subscription by ID from the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/subscriptions.readonly`.

Retrieve one payment transaction by ID from the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/transactions.readonly`.

Return one offset page of coupons for the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/coupons.readonly`.

Return one offset page of white-label payment integration providers for the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/integration.readonly`.

List fulfillment history for one order in the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/orders.readonly`.

List notes for one payment order in the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/orders.readonly`.

Return one offset page of orders for the connected Location. altType is fixed to the live-required value `location`. Location PITs must be provisioned with the HighLevel permission: `payments/orders.readonly`.

Return one offset page of subscriptions for the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/subscriptions.readonly`.

Return one offset page of payment transactions for the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/transactions.readonly`.

Record a real manual payment against an order. This changes financial balances and may mark the order paid; confirm the order ID, amount, currency, payment method, and partial-payment intent before calling. Do not use this action to test connectivity. Location PITs must be provisioned with the HighLevel permission: `payments/orders.collectPayment`.

Replace an existing coupon's promotional terms. applyToFuturePaymentsConfig is ignored unless applyToFuturePayments is true. Confirm the coupon ID, discount, dates, limits, eligible products, and future subscription effects before calling. Location PITs must be provisioned with the HighLevel permission: `payments/coupons.write`.

List one page of active numbers and phone-account state for the connected HighLevel location. Pass `next_cursor` back as `page` for the next page. This action depends on external phone-system state. Location PITs must be provisioned with the HighLevel permission: `phonenumbers.read`.

List number pools for the connected HighLevel location. This action requires the location's external phone-system state to be configured. Location PITs must be provisioned with the HighLevel permission: `numberpools.read`.

Search external phone-provider inventory for numbers purchasable by the connected HighLevel location. This does not purchase or reserve a number. Location PITs must be provisioned with the HighLevel permission: `phonenumbers.read`.

Purchase a phone number for the connected HighLevel location from external provider inventory. This can incur an immediate charge. Explicit confirmation is required, and this toolkit surface has no action for releasing the number. HighLevel rejects purchases when the location is not KYC verified, including when skip_location_kyc is true. Location PITs must be provisioned with the HighLevel permission: `phonenumbers.write`.

Edit fields on up to 30 products and nested prices in one request. Confirm every product ID and changed field before calling. Location PITs must be provisioned with the HighLevel permission `products.write`.

Bulk-update product prices, availability, collections, or currency, or permanently delete products when type is `bulk-delete-products`. Collection updates add products to collections and never remove existing collection assignments. Confirm the operation type and product IDs before calling. Location PITs must be provisioned with the HighLevel permission: `products.write`.

Update one or multiple product reviews: status, reply, etc. Location PITs must be provisioned with the HighLevel permission: `products.write`.

The "Create Price for a Product" API allows adding a new price associated with a specific product to the system. Use this endpoint to create a price with the specified details for a particular product. Ensure that the required information is provided in the request payload. Location PITs must be provisioned with the HighLevel permission: `products/prices.write`.

The "Create Product" API allows adding a new product to the system. Use this endpoint to create a product with the specified details. Ensure that the required information is provided in the request payload. Location PITs must be provisioned with the HighLevel permission: `products.write`.

Create a new Product Collection for a specific location Location PITs must be provisioned with the HighLevel permission: `products/collection.write`.

The "Delete Price by ID for a Product" API allows deleting a specific price associated with a particular product using its unique identifier. Use this endpoint to remove a price from the system. Location PITs must be provisioned with the HighLevel permission: `products/prices.write`.

The "Delete Product by ID" API allows deleting a specific product using its unique identifier. Use this endpoint to remove a product from the system. Location PITs must be provisioned with the HighLevel permission: `products.write`.

Delete specific product collection with Id :collectionId Location PITs must be provisioned with the HighLevel permission: `products/collection.write`.

Delete specific product review Location PITs must be provisioned with the HighLevel permission: `products.write`.

The "List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the inventory based on the provided query parameters. Location PITs must be provisioned with the HighLevel permission: `products/prices.readonly`.

The "Get Price by ID for a Product" API allows retrieving information for a specific price associated with a particular product using its unique identifier. Use this endpoint to fetch details for a single price based on the provided price ID and product ID. Location PITs must be provisioned with the HighLevel permission: `products/prices.readonly`.

The "Get Product by ID" API allows to retrieve information for a specific product using its unique identifier. Use this endpoint to fetch details for a single product based on the provided product ID. Location PITs must be provisioned with the HighLevel permission: `products.readonly`.

Fetch product collections for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `products/collection.readonly`.

Get Details about individual product collection Location PITs must be provisioned with the HighLevel permission: `products/collection.readonly`.

API to fetch the Product Reviews Location PITs must be provisioned with the HighLevel permission: `products.readonly`.

API to fetch the total number of products, included in the store, and excluded from the store and other stats Location PITs must be provisioned with the HighLevel permission: `products.readonly`.

API to fetch the Review Count as per status Location PITs must be provisioned with the HighLevel permission: `products.readonly`.

The "List Prices for a Product" API allows retrieving a paginated list of prices associated with a specific product. Customize your results by filtering prices or paginate through the list using the provided query parameters. Location PITs must be provisioned with the HighLevel permission: `products/prices.readonly`.

The "List Products" API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve product information. Location PITs must be provisioned with the HighLevel permission: `products.readonly`.

Set product display priorities for a store in the connected Location. Confirm the complete intended ordering before calling. Location PITs must be provisioned with the HighLevel permission: `products.write`.

The Update Inventory API allows the user to bulk update the inventory for multiple items. Use this endpoint to update the available quantity and out-of-stock purchase settings for multiple items in the inventory. Location PITs must be provisioned with the HighLevel permission: `products/prices.write`.

Replace a product price by ID. This is a full replacement: resend every field to retain, including SKU, description, recurring schedule, trial period, total cycles, setup fee, compare-at price, shipping options, inventory settings, and digital-delivery settings. Omitted optional fields are cleared. Location PITs must be provisioned with the HighLevel permission: `products/prices.write`.

Update a product by ID. HighLevel ignores product_type and clears taxInclusive when tax_inclusive is omitted. Location PITs must be provisioned with the HighLevel permission: `products.write`.

Update a specific product collection with Id :collectionId Location PITs must be provisioned with the HighLevel permission: `products/collection.write`.

Update status, reply, etc of a particular review Location PITs must be provisioned with the HighLevel permission: `products.write`.

API to update the status of products in a particular store Location PITs must be provisioned with the HighLevel permission: `products.write`.

Return one page of proposal and contract documents for the connected HighLevel location. Availability may depend on an account entitlement that has not been verified. Location PITs must be provisioned with the HighLevel permission: `documents_contracts/list.readonly`.

Return one page of proposal and contract templates for the connected HighLevel location. Availability may depend on an account entitlement that has not been verified. Location PITs must be provisioned with the HighLevel permission: `documents_contracts_template/list.readonly`.

Irreversibly send an existing proposal or contract to external recipients for the connected HighLevel location. Review the document, recipients, sender, and delivery medium before calling. Availability may depend on an unverified account entitlement. Location PITs must be provisioned with the HighLevel permission: `documents_contracts/sendLink.write`.

Create a proposal or contract from a template for a contact in the connected HighLevel location. Setting `send_document=true` or omitting it sends externally and is irreversible; pass `false` to create a draft. Availability may depend on an unverified account entitlement. Location PITs must be provisioned with the HighLevel permission: `documents_contracts_template/sendLink.write`.

Search targeting options on Facebook Ads, Google Ads, or LinkedIn Ads. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.

Attach an account returned by SOCIAL_PLANNER_GET_OAUTH_ACCOUNTS (step 2 of the OAuth flow). Copy its provider identifiers unchanged: Instagram requires page_id; LinkedIn requires type and urn; YouTube, Threads, and Pinterest require type='profile'; Google Business Profile requires both location and account. Location PITs must be provisioned with the HighLevel permission: `socialplanner/oauth.write`. Explicit confirmation is required before this mutation is sent.

Idempotently soft-delete up to 50 Social Planner posts from HighLevel. Repeating a deletion may report the same count again, and `SOCIAL_PLANNER_GET_POSTS` does not list these records with its `deleted` filter. Confirm all post IDs before calling. The proven six-scope OAuth union is sufficient, but HighLevel does not map this endpoint to one individually necessary scope; no Social Planner-specific PIT permission was enforced by the minimal-PIT probe.

Duplicates an existing queue item at a specified order position. Requires an active edit session. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.write`. Explicit confirmation is required before this mutation is sent.

Create a top-level post comment (`isParentThread: true`, `parentId` = post ID) or reply (`isParentThread: false`, `parentId` = comment ID). Attachments work only on Facebook; mentions work on Facebook, LinkedIn, and Community; `notifyAllGroupMembers` broadcasts only in Community and is ignored elsewhere. Content limits are Facebook 8000, Instagram 2200, LinkedIn 3000, Community 8000, TikTok 150, Bluesky 300, YouTube 10000, and Threads 500 characters. Location PITs must be provisioned with `socialplanner/comments.write`. Explicit confirmation is required.

Like a comment by its **Highlevel** comment ID (the `_id` returned by the list-comments endpoint — not the native platform ID). Works for any comment level — top-level comments, replies, and replies-to-replies. **Supported platforms:** Facebook, LinkedIn, Community, TikTok, Bluesky. Instagram is not supported (passing `instagram` returns 400). Location PITs must be provisioned with the HighLevel permission: `socialplanner/comments.write`. Explicit confirmation is required before this mutation is sent.

Create a draft or publish/schedule content on connected external social networks. An immediate `published` request can succeed without returning a post ID; recover the created record with `SOCIAL_PLANNER_GET_POSTS` using a narrow `from_date`/`to_date` window around creation. Non-draft requests require explicit confirmation because they may make content public or notify followers. Location PITs must be provisioned with the HighLevel permission: `socialplanner/post.write`.

Creates a queue in draft status for a category. Published posts are auto-added. Use update endpoint to activate. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.write`. Explicit confirmation is required before this mutation is sent.

Adds a new post item to a queue. Use sessionId for edit session or directToQueue for immediate addition. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.write`. Explicit confirmation is required before this mutation is sent.

Delete account and account from group Location PITs must be provisioned with the HighLevel permission: `socialplanner/account.write`.

Delete a CSV import and all its associated posts Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.write`.

Delete a specific post from a CSV import Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.write`.

Deletes a post that is currently scheduled and automatically triggers the scheduling of the next available post in the queue. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.write`. Explicit confirmation is required before this mutation is sent.

Remove a like from a comment by its **Highlevel** comment ID (the `_id` returned by the list-comments endpoint — not the native platform ID). Works for any comment level — top-level comments, replies, and replies-to-replies. **Supported platforms:** Facebook, LinkedIn, Community, TikTok, Bluesky. Instagram is not supported (passing `instagram` returns 400). Location PITs must be provisioned with the HighLevel permission: `socialplanner/comments.write`. Explicit confirmation is required before this mutation is sent.

Soft-delete one Social Planner post from HighLevel idempotently through the bulk-delete operation. Repeating the deletion may still report `deletedCount: 1`, and `SOCIAL_PLANNER_GET_POSTS` does not list these records with its `deleted` filter. This does not guarantee removal from an external social network. Location PITs must be provisioned with the HighLevel permission: `socialplanner/post.write`.

Deletes an item from a specific category queue. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.write`. Explicit confirmation is required before this mutation is sent.

Cancels the edit session and deletes all staged changes without affecting the live queue. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.write`. Explicit confirmation is required before this mutation is sent.

Edit an existing Social Planner post and optionally republish or reschedule it on its connected external networks. This PUT replaces stored post fields: GET the post first and resend values such as category, schedule date, and media that must be preserved. Non-draft changes require explicit confirmation because they may update public content or notify followers. Location PITs must be provisioned with the HighLevel permission: `socialplanner/post.write`.

Returns categories with status: "available" (no queue), "in_queue" (active/paused queue), or "draft" (queue in draft). Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.readonly`.

Returns scheduled posts from active queues within a date range. Supports filtering by categories and accounts. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.readonly`.

Retrieves a calendar preview of scheduled posts based on draft items within an edit session. This shows how posts would be scheduled if changes were saved. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.readonly`.

Retrieves the details of a single category queue by its unique ID. The response includes a count of posts within the queue that have errors. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.readonly`.

Returns paginated queue items. Pass sessionId to get draft items from an edit session instead of live items. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.readonly`.

Retrieves a paginated list of all category queues for a given location, excluding any that have been marked as deleted. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.readonly`.

Returns paginated slot information (scheduledDateTime, isSkipped) for queue items. Pass sessionId to get slots for draft items, or omit for live items. Call this after mutations to refresh slot data. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.readonly`.