How to integrate HighLevel Location MCP with Hermes

Add a member to a Facebook custom audience Location PITs must be provisioned with the HighLevel permission: `adPublishing.

Queue an asynchronous job to add, remove, or replace Facebook custom-audience members via CSV or smart lists.

Create a new Facebook conversation lead form.

Create a new lead form on a Facebook page.

Permanently delete a Facebook ad.

Archive a Facebook ad set and remove its ads.

Archive a Facebook campaign and its ad sets.

Delete a Facebook custom audience by ID Location PITs must be provisioned with the HighLevel permission: `adPublishing.

Remove the Facebook ad integration from a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.

Remove a Facebook page connection from a location.

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

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

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

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

Return the current Meta publishing step counts and completion state for a Facebook campaign.

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

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

Retrieve Facebook custom audiences for a location.

List Facebook campaigns, ad sets, or ads that exist on Meta.

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

Retrieve a specific published or draft Facebook lead form by ID.

Retrieve lead forms for a Facebook page.

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

Retrieve Facebook conversion pixels for a location.

Pause a published Facebook ad.

Pause a published Facebook ad set.

Pause a published Facebook campaign.

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

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

Resume a paused Facebook ad.

Resume a paused Facebook ad set.

Resume a paused Facebook campaign.

Set the default Facebook page for a location.

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

Create or update a Facebook ad.

Create or update a Facebook ad set.

Create or update a Facebook campaign.

Create or update a Facebook conversion pixel.

Create a job to upload users to an existing Google Customer Match list.

Soft-delete a Google Ads conversion action by ID.

Delete a Google Ads audience segment by ID.

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

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

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

Retrieve a specific Google Ads campaign by ID, including its ad groups and ad content.

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

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

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

Retrieve Google-side campaigns, ad groups, or ads through the current AD_MANAGER path.

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

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

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

Retrieve affinity and in-market audience options for Google Ads targeting.

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

Create or update Google Ads creative assets.

Create or update a Google Ads combined audience.

Create or update a full Google Ads campaign structure.

Create or update a Google Ads conversion action.

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

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

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

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

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

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

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

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

Retrieve a single affiliate by id for a location.

Retrieve the list of affiliates for a location.

Retrieve the list of commissions for a location.

Retrieve the list of payouts for a location.

Create an Agent Studio agent with an initial staging version.

Permanently delete an Agent Studio agent and all of its versions.

Execute an active Agent Studio agent and return its complete non-streaming response.

Get one active Agent Studio agent and all of its non-deleted versions.

List active Agent Studio agents for the connected Location, one page at a time.

Irreversibly promote an Agent Studio draft version to production.

Update an Agent Studio agent's name, description, or status.

Update a specific Agent Studio version.

Create a user-defined association between supported HighLevel object types.

Create a relation between two records in the association definition's canonical first-object then second-object order; reversing the records is invalid.

Permanently delete a user-defined association.

Permanently delete one relation between associated records.

Return a page of association definitions for the connected Location.

Get a system- or user-defined association by its ID.

Get association definitions for a contact, opportunity, or custom-object key.

Get a standard or user-defined association definition by its key name.

Return a page of relations for a record, optionally filtered by association IDs.

Update the first- and second-object labels of an association definition.

Check whether a URL slug is already used by a blog post in the connected HighLevel Location.

Create a blog post in the connected HighLevel Location.

Return one offset-based page of blog authors for the connected HighLevel Location.

Return one offset-based page of blog categories for the connected HighLevel Location.

Return one offset-based page of posts for a blog in the connected HighLevel Location.

Return one offset-based page of blogs for the connected HighLevel Location.

Update an existing blog post in the connected HighLevel Location.

Create a brand board with logos, colors, and fonts in the connected HighLevel location.

Create a brand voice in the connected location.

Delete a brand board from the connected HighLevel location.

Delete a brand voice after explicit confirmation.

Retrieve one brand board by ID from the connected HighLevel location.

Return one page of brand boards for the connected HighLevel location.

Get a brand voice from the connected location.

Return one page of brand voices for the connected location.

Set the location's default brand voice, replacing the previous default, after explicit confirmation.

Update an existing brand board in the connected HighLevel location.

Update a brand voice after explicit confirmation.

Create a business in the connected HighLevel location.

Permanently delete a business by ID.

Retrieve one business by ID.

Return one offset-paginated page of businesses for the connected HighLevel location.

Update editable details of an existing business by ID.

Associate a calendar with a schedule.

Create an appointment.

Create an appointment note.

Create a block slot for exactly one owner: assigned_user_id or calendar_id.

Create calendar in a location.

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

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

Create or replace the availability schedule for an event calendar.

Create Calendar notifications, either one or multiple.

Create new schedule with specified rules, timezone, location, user and calendar associations.

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

Create new service in a location.

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

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

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

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

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

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

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

Permanently remove a schedule and all its associated rules.

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

Delete a service catalog item by ID.

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

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

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

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

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

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

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

Retrieve user availability schedules based on various filters including location, calendar, and user.

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

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

Get blocked slots for exactly one owner: user_id, calendar_id, or group_id.

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

Get calendar events for exactly one owner: user_id, calendar_id, or group_id.

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

Get all calendars in a location.

Retrieve the availability schedule for a specific event calendar.

Get calendar notifications.

Get all calendar groups in a location.

Retrieve a specific schedule by its unique identifier.

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

Retrieve service bookings for a location within a given date range, with an optional service location filter.

Get service by ID.

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

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

Get all services in a location.

Get free slots for a calendar between a date range.

Remove a calendar from a schedule.

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

Update calendar by ID.

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

Update the availability schedule for a specific event calendar.

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

Modify an existing schedule by updating its rules, timezone, and name All fields are optional - only provided fields will be updated.

Update an existing service booking.

Update service by ID.

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

Validate if group slug is available or not.

Return campaigns for the connected HighLevel location, optionally filtered by status.

Creates a copy of a chat widget in the connected sub-account.

Creates a new chat widget for the connected sub-account.

Soft-deletes a chat widget from the connected sub-account.

Returns a single chat widget by ID from the connected sub-account.

Return a chat widget's public configuration by widget ID.

Returns chat widgets for the connected sub-account with pagination and optional filters.

Partially updates a chat widget in the connected sub-account.

Fully updates a chat widget in the connected sub-account.

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

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

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

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

Submit a job to assign one business to up to 50 contacts, or remove their business association with `remove_business=true`.

Add or remove tags for multiple contacts, including optionally removing all tags.

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

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

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

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

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

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

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

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

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

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

Retrieves a contact by its unique identifier.

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

Get Duplicate Contact.

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

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

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

Removes the contact from every campaign it is enrolled in.

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

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

Search contacts using advanced filters and return one cursor-controlled page.

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

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

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

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

The Upsert API will adhere to the configuration defined under the "Allow Duplicate Contact" setting at the Location level.

Creates and attach a new action for an AI agent.

Creates a new AI agent for the location.

Permanently deletes an action.

Deletes an AI agent permanently.

Retrieves detailed information about a specific action using its unique identifier.

Retrieves a specific AI agent by its ID.

Retrieves detailed information about AI responses including the System Prompt, Conversation history, Knowledge base, website, FAQ chunks, and Rich Text chunks.

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

Search AI agents by lowercase name query.

Updates an existing action's configuration.

Fully replace the required personality, goal, and instructions of an existing AI agent; omitted optional fields keep their current values.

Update followupSettings for one or more advancedFollowup actions.

Post the necessary fields for the API to add a new inbound message.

Post the necessary fields for the API to add a new outbound call.

Set attachments on an existing message (replaces existing).

Post the messageId for the API to delete a scheduled email message.

Post the messageId for the API to delete a scheduled message.

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

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

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

Return one page of messages for the connected HighLevel location, with a cursor for continuation.

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

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

Get message by message id.

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

Get messages by conversation id.

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

Set the typing indicator for a conversation started by a live-chat widget visitor.

Return one page of conversations for the connected HighLevel location and an opaque cursor for the next page.

Send an external message to a contact through the selected channel.

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

Update delivery events, per-recipient statuses, and the overall message status for an email sent via a custom conversation provider.

Post the necessary fields for the API to update message status.

Post the necessary fields for the API to upload files.

Import course products into the connected HighLevel location.

Connect one supported ad platform to the Location using the provider-specific account identifiers.

Create a custom field for a custom object or Company (Business) object in the connected HighLevel location.

Create a custom field folder for a custom object in the connected HighLevel location.

Permanently delete a custom field by ID.

Permanently delete a custom field folder from the connected HighLevel location.

Get a custom field or folder by ID.

List custom fields and folders for an object key in the connected HighLevel location.

Update a custom field by ID in the connected HighLevel location.

Rename a custom field folder in the connected HighLevel location.

Disconnect an ad account from one supported ad platform.

Verify an email address or a HighLevel contact's email.

Create an email campaign draft without scheduling or sending it.

Create a new email template in the connected HighLevel location.

Create an email-template folder in the connected HighLevel location.

Delete an email campaign.

Permanently delete one email template from the connected HighLevel location.

Get one bulk-action campaign from the connected HighLevel location.

Get statistics for an email, workflow, or bulk-action campaign.

Get one email campaign from the connected HighLevel location.

Get one email template from the connected HighLevel location.

Get one workflow campaign from the connected HighLevel location.

Import an email template from a supported provider URL into the connected location.

Return one page of bulk-action campaigns for the connected HighLevel location.

Return one page of email campaigns for the connected HighLevel location.

Return one page of email templates and folders for the connected HighLevel location.

Return one page of workflow campaigns for the connected HighLevel location.

Start or schedule a draft or paused email campaign after validating recipients and schedule configuration.

Update selected fields of an email campaign draft; this action never schedules or sends it.

Update selected fields of an email template in the connected HighLevel location.

Get metadata and a short-lived signed download URL for a HighLevel file share slug.

Return one offset-based page of forms for the connected HighLevel location.

Return one page of form submissions for the connected HighLevel location.

Upload one or more files to file-upload custom fields on a contact in the connected HighLevel location.

Create a URL redirect for the connected HighLevel Location.

Permanently delete a URL redirect from the connected HighLevel Location.

Return one offset-based page of URL redirects for the connected HighLevel Location.

Return one offset-based page of funnels for the connected HighLevel Location.

Return one offset-based page of pages belonging to a HighLevel funnel.

Count pages belonging to a HighLevel funnel, optionally filtered by name.

Update the destination and action of an existing HighLevel URL redirect.

Return one ad account or the selected account details for one ad platform.

Return reporting metrics for one Facebook or Google ad campaign.

Return the Location's integration state for one ad platform.

Return the current user from one connected ad platform.

Return aggregate reporting metrics for one connected ad platform.

API to manage auto payment for a schedule.

API to cancel a scheduled invoice by schedule id.

Create a new estimate template.

API to create an invoice.

Create a new invoice from an existing estimate.

API to create an invoice Schedule.

Create an invoice template.

Create a new estimate.

Delete an existing estimate.

Delete an existing estimate template.

Permanently delete a draft invoice by ID.

API to delete an schedule by schedule id.

Permanently delete an invoice template by ID.

Get the next estimate number for the given location.

Get the next invoice number for the given location.

Get an invoice by ID.

API to get an schedule by schedule id.

Get the invoice settings for the given location.

API to get an template by template id.

Get a paginated list of estimates.

Get a list of estimate templates or a specific template by ID.

API to get list of invoices.

API to get list of schedules.

API to get list of templates.

Get a preview of an estimate template.

Record a manual payment against an invoice.

API to schedule an schedule invoice to start sending to the customer.

API to send estimate by estimate id.

API to send invoice by invoice id.

Create or update a text-to-pay invoice.

Replace the contents of an invoice schedule that is already in `scheduled` state; call SCHEDULE_INVOICE_SCHEDULE first for a draft.

Update an existing estimate.

Update an estimate's last-visited timestamp by estimate ID.

Update an existing estimate template.

Update an invoice by invoice ID.

Mark an invoice as last visited in the connected Location.

Replace late-fee settings on an invoice in the connected Location.

Replace an invoice schedule by schedule ID.

Update an invoice template by ID.

Replace an invoice template's late-fee configuration in the connected Location.

Replace payment-method settings on an invoice template in the connected Location.

Void a non-draft invoice by ID without deleting its record.

Create an FAQ after explicit confirmation.

Create a knowledge base after explicit confirmation.

Idempotently delete an FAQ after explicit confirmation; deleting an already-deleted FAQ is treated as successful.

Delete a knowledge base after explicit confirmation.

Idempotently delete trained pages after explicit confirmation; repeated deletion may still report a positive deletedCount.

Start website discovery after explicit confirmation.

Return one page of crawled website URLs.

Get crawler operation status.

Get a knowledge base by ID.

Return one page of knowledge bases for the connected location.

Return one page of FAQs.

Queue discovered pages for training after explicit confirmation.

Update an FAQ after explicit confirmation.

Update a knowledge base after explicit confirmation.

Create a trigger link in the connected HighLevel location.

Permanently delete a trigger link by ID.

Get a single trigger link by ID from the connected HighLevel location.

Get all trigger links in the connected HighLevel location.

Return one offset-based page of trigger links matching a search query.

Update a trigger link's name and redirect destination.

List ad accounts available through one connected ad platform.

List published reporting entities for one connected ad platform.

Create a custom field in the connected HighLevel Location.

Create a custom value in the connected HighLevel Location.

Create Recurring Task Location PITs must be provisioned with the HighLevel permission: `recurring-tasks.

Create a tag in the connected HighLevel Location.

Delete a custom field from the connected HighLevel Location.

Delete a custom value from the connected HighLevel Location.

Delete Recurring Task Location PITs must be provisioned with the HighLevel permission: `recurring-tasks.

Delete a tag from the connected HighLevel Location.

Return one offset-based page of templates from the connected HighLevel Location.

Get SMS or email channel providers configured for the connected HighLevel Location.

Get one custom field from the connected HighLevel Location.

List custom fields owned by the connected HighLevel Location.

Get one custom value from the connected HighLevel Location.

List custom values owned by the connected HighLevel Location.

Get the Location bound to the connected HighLevel account.

List tags owned by the connected HighLevel Location.

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

Get one tag from the connected HighLevel Location.

Fetch the available timezones for the connected HighLevel Location.

Return one offset-based page of tasks from the connected HighLevel Location.

Update a custom field in the connected HighLevel Location.

Update a custom value in the connected HighLevel Location.

Update Recurring Task Location PITs must be provisioned with the HighLevel permission: `recurring-tasks.

Rename a tag in the connected HighLevel Location.

Upload a file to a custom field for the connected HighLevel Location.

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

Create a real wallet charge for the connected HighLevel Location.

Delete a wallet charge.

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.

Delete or trash multiple files and folders in the connected Location.

Rename multiple files or folders in the connected Location's media storage.

Create a folder in the connected Location's media storage.

Delete a file or folder from the connected HighLevel location's media storage.

Fetch files and folders from the connected HighLevel location's media storage.

Rename one file or folder in the connected Location's media storage.

Upload a file or import a hosted file into HighLevel media storage.

Create a business or custom object record with schema-defined fields.

Permanently delete a business or custom object record by ID.

List standard and custom object schemas for the connected HighLevel location.

Retrieve an object schema by key or ID, optionally including its fields.

Retrieve a business or custom object record by ID.

Return one page of business or custom object records matching a search expression.

Update a custom object's labels, description, and searchable fields, or update searchable fields for a standard object.

Update a standard or custom object record with schema-defined fields.

Add up to 10 user IDs as followers of an opportunity and return the resulting follower list.

Create an opportunity.

Create a pipeline with at least one stage in the connected HighLevel location.

Delete Opportunity.

Permanently delete a pipeline and every opportunity in all its stages.

Get lost reason.

Get Opportunity.

Retrieve one pipeline, including its stages and configuration.

Get Pipelines.

Allows removal of one or all followers from an opportunity.

Search opportunities based on combinations of advanced filters.

Search Opportunity.

Update Opportunity.

Update Opportunity Status.

Update a pipeline.

Upsert Opportunity.

Create a promotional coupon.

Create a custom payment-provider association for the connected Location.

Create a Location payment-provider integration backed by Authorize.

Create fulfillment history for an order.

Set whether the connected Location's custom payment provider supports subscription schedules.

Permanently delete a coupon.

Permanently delete the connected Location's custom payment-provider association.

Disconnect a custom provider's live or test payment configuration.

Fetch the custom payment-provider configuration for the connected Location.

Retrieve coupon details by ID for the connected Location.

Retrieve one order by ID from the connected Location.

Retrieve one payment subscription by ID from the connected Location.

Retrieve one payment transaction by ID from the connected Location.

Return one offset page of coupons for the connected Location.

Return one offset page of white-label payment integration providers for the connected Location.

List fulfillment history for one order in the connected Location.

List notes for one payment order in the connected Location.

Return one offset page of orders for the connected Location.

Return one offset page of subscriptions for the connected Location.

Return one offset page of payment transactions for the connected Location.

Record a real manual payment against an order.

Replace an existing coupon's promotional terms.

List one page of active numbers and phone-account state for the connected HighLevel location.

List number pools for the connected HighLevel location.

Search external phone-provider inventory for numbers purchasable by the connected HighLevel location.

Purchase a phone number for the connected HighLevel location from external provider inventory.

Edit fields on up to 30 products and nested prices in one request.

Bulk-update product prices, availability, collections, or currency, or permanently delete products when type is `bulk-delete-products`.

Update one or multiple product reviews: status, reply, etc.

The "Create Price for a Product" API allows adding a new price associated with a specific product to the system.

The "Create Product" API allows adding a new product to the system.

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

The "Delete Price by ID for a Product" API allows deleting a specific price associated with a particular product using its unique identifier.

The "Delete Product by ID" API allows deleting a specific product using its unique identifier.

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

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

The "List Inventory API allows the user to retrieve a paginated list of inventory items.

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.

The "Get Product by ID" API allows to retrieve information for a specific product using its unique identifier.

Fetch product collections for the connected HighLevel Location.

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

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

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.

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

The "List Prices for a Product" API allows retrieving a paginated list of prices associated with a specific product.

The "List Products" API allows to retrieve a paginated list of products.

Set product display priorities for a store in the connected Location.

The Update Inventory API allows the user to bulk update the inventory for multiple items.

Replace a product price by ID.

Update a product by ID.

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

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

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

Return one page of proposal and contract documents for the connected HighLevel location.

Return one page of proposal and contract templates for the connected HighLevel location.

Irreversibly send an existing proposal or contract to external recipients for the connected HighLevel location.

Create a proposal or contract from a template for a contact in the connected HighLevel location.

Search targeting options on Facebook Ads, Google Ads, or LinkedIn Ads.

Attach an account returned by SOCIAL_PLANNER_GET_OAUTH_ACCOUNTS (step 2 of the OAuth flow).

Idempotently soft-delete up to 50 Social Planner posts from HighLevel.

Duplicates an existing queue item at a specified order position.

Create a top-level post comment (`isParentThread: true`, `parentId` = post ID) or reply (`isParentThread: false`, `parentId` = comment ID).

Like a comment by its **Highlevel** comment ID (the `_id` returned by the list-comments endpoint — not the native platform ID).

Create a draft or publish/schedule content on connected external social networks.

Creates a queue in draft status for a category.

Adds a new post item to a queue.

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

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

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

Deletes a post that is currently scheduled and automatically triggers the scheduling of the next available post in the queue.

Remove a like from a comment by its **Highlevel** comment ID (the `_id` returned by the list-comments endpoint — not the native platform ID).

Soft-delete one Social Planner post from HighLevel idempotently through the bulk-delete operation.

Deletes an item from a specific category queue.

Cancels the edit session and deletes all staged changes without affecting the live queue.

Edit an existing Social Planner post and optionally republish or reschedule it on its connected external networks.

Returns categories with status: "available" (no queue), "in_queue" (active/paused queue), or "draft" (queue in draft).

Returns scheduled posts from active queues within a date range.

Retrieves a calendar preview of scheduled posts based on draft items within an edit session.

Retrieves the details of a single category queue by its unique ID.

Returns paginated queue items.

Retrieves a paginated list of all category queues for a given location, excluding any that have been marked as deleted.

Returns paginated slot information (scheduledDateTime, isSkipped) for queue items.

Get list of accounts and groups Location PITs must be provisioned with the HighLevel permission: `socialplanner/account.

Retrieve a specific category by its ID Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.

Retrieve all categories for a specific location with optional search and pagination Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.

Paginated list of comments scoped to a post (`parentId` = postId) or a comment thread (`parentId` = commentId).

Get details of a specific CSV import including its posts Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.

Step 2 of the Social Planner OAuth flow: after Start OAuth returns an account ID, list the Facebook pages, Instagram professional accounts, Google Business Profile locations, LinkedIn organizations, TikTok accounts, YouTube channels, Pinterest accounts, Threads profiles, or Bluesky profiles available to attach.

Get post Location PITs must be provisioned with the HighLevel permission: `socialplanner/post.

Get Social Planner posts.

Retrieve analytics data for multiple social media accounts.

Retrieve specific tags by their IDs Location PITs must be provisioned with the HighLevel permission: `socialplanner/tag.

Retrieve all tags for a specific location with optional search and pagination Location PITs must be provisioned with the HighLevel permission: `socialplanner/tag.

Get the status of all CSV imports for a location Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.

Reset a staged queue item to its original state.

Applies all staged changes to the live queue and closes the edit session.

Set social media accounts for a CSV import to publish posts to Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.

Finalize a CSV import and schedule all posts for publishing Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.

Creates a draft copy of queue items for editing.

Updates queue status (active/paused/deleted), time slots, or skip dates.

Updates the content or variations of a specific item within a category queue.

Upload a CSV file containing social media posts for bulk scheduling Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.

Create a shipping carrier after explicit confirmation.

Create a shipping rate after explicit confirmation.

Create a shipping zone after explicit confirmation.

Delete a shipping carrier after explicit confirmation.

Delete a shipping rate after explicit confirmation.

Delete a shipping zone after explicit confirmation.

Calculate available shipping-rate quotes without changing provider state.

Get a shipping carrier by ID.

Get a shipping rate by ID.

Get a shipping zone by ID.

Get store settings for the connected location.

List shipping carriers.

Return one page of shipping rates.

Return one page of shipping zones.

Update a shipping carrier after explicit confirmation.

Update a shipping rate after explicit confirmation.

Update a shipping zone after explicit confirmation.

Return one offset-based page of surveys for the connected HighLevel location.

Return one page of survey submissions for the connected HighLevel location.

Queue deletion of an existing HighLevel user.

Retrieve one HighLevel user by ID.

Search users belonging to the connected HighLevel Location.

Update non-password fields of an existing HighLevel user.

Create a behavior or capability for an existing Voice AI agent in the connected HighLevel Location.

Create a Voice AI agent in the connected HighLevel Location.

Permanently remove an action and its configuration from a Voice AI agent in the connected HighLevel Location.

Permanently delete a Voice AI agent and its configuration from the connected HighLevel Location.

Retrieve one action configured for a Voice AI agent in the connected HighLevel Location.

Retrieve one Voice AI agent owned by the connected HighLevel Location.

List Voice AI agents in the connected HighLevel Location.

Retrieve one Voice AI call log owned by the connected HighLevel Location.

List Voice AI call logs in the connected HighLevel Location with documented filters, sorting, and one-page continuation.

Partially update a Voice AI agent in the connected HighLevel Location.

Replace an existing Voice AI agent action configuration in the connected HighLevel Location.

Return the workflows available to the connected HighLevel location.