PrecisionBook a discovery call
Menu

HighLevel Location for AI agents

Agents read HighLevel Location at once. Changes and sends are held for a person's approval by default.

Book a discovery callBrowse all connectors

About HighLevel Location

HighLevel provides Location-scoped CRM, marketing, conversations, calendars, payments, and business automation APIs.

What an agent can do in HighLevel Location

Every HighLevel Location action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.

Runs at once (reads)

Looks things up in HighLevel Location without asking first. 233 actions.

  • Get campaign with linked entitiesRetrieve a Facebook campaign with its linked adsets and ads Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get Facebook Campaign Publishing ProgressReturn 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 with
  • Get conversation formsRetrieve Facebook conversation lead forms for a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get custom audience by IDRetrieve a specific Facebook custom audience by its ID Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get custom audiencesRetrieve 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 provis
  • Get entitiesList 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 th
  • Get Instagram accounts for pageRetrieve Instagram accounts linked to a specific Facebook page Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get lead form by IDRetrieve 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`.
  • Get page lead formsRetrieve 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. Locat
  • Get Facebook pagesRetrieve Facebook pages associated with the connected account Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get conversion pixelsRetrieve 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 lis
  • Get assetsRetrieve Google Ads creative assets for a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
Show all 233
  • Get audience by IDRetrieve a specific Google Ads combined audience by ID Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get audiencesRetrieve Google Ads combined audiences for a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get Google Campaign by IDRetrieve 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`.
  • Get conversion by IDRetrieve a specific Google Ads conversion action by ID Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get conversion goalsRetrieve Google Ads conversion goals for a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get conversionsRetrieve Google Ads conversion actions for a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get entitiesRetrieve 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
  • Get keyword ideasRetrieve keyword suggestions for Google Ads campaigns Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get segment by IDRetrieve a specific Google Ads audience segment by ID Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get segmentsRetrieve Google Ads audience segments for a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get target interestsRetrieve 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.
  • Get ad campaign groupRetrieve a LinkedIn ad campaign group by ID Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get campaign group reportingRetrieve reporting metrics for a specific LinkedIn campaign group Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get lead formsRetrieve LinkedIn lead gen forms for an ad account Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get AffiliateRetrieve a single affiliate by id for a location. Location PITs must be provisioned with the HighLevel permission: `affiliate-manager.readonly`.
  • List AffiliatesRetrieve the list of affiliates for a location. Location PITs must be provisioned with the HighLevel permission: `affiliate-manager.readonly`.
  • List CommissionsRetrieve the list of commissions for a location. Location PITs must be provisioned with the HighLevel permission: `affiliate-manager.readonly`.
  • List PayoutsRetrieve the list of payouts for a location. Location PITs must be provisioned with the HighLevel permission: `affiliate-manager.readonly`.
  • Get AgentGet 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 AgentsList 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`.
  • List associationsReturn a page of association definitions for the connected Location. Location PITs must be provisioned with the HighLevel permission: `associations.readonly`.
  • Get association by IDGet a system- or user-defined association by its ID. Location PITs must be provisioned with the HighLevel permission: `associations.readonly`.
  • Get associations by object keyGet association definitions for a contact, opportunity, or custom-object key. Location PITs must be provisioned with the HighLevel permission: `associations.readonly`.
  • Get association by key nameGet a standard or user-defined association definition by its key name. Location PITs must be provisioned with the HighLevel permission: `associations.readonly`.
  • Get relations by record IDReturn 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
  • Check blog URL slugCheck 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`.
  • List blog authorsReturn one offset-based page of blog authors for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `blogs/author.readonly`.
  • List blog categoriesReturn one offset-based page of blog categories for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `blogs/category.readonly`.
  • List blog postsReturn 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`.
  • List blogsReturn one offset-based page of blogs for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `blogs/list.readonly`.
  • Get Brand BoardRetrieve one brand board by ID from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `brand-boards/design-kit.readonly`.
  • Get Brand BoardsReturn 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 Brand VoiceGet a brand voice from the connected location. Location PITs require `brand-boards/voices.readonly`.
  • List Brand VoicesReturn one page of brand voices for the connected location. Location PITs require `brand-boards/voices.readonly`.
  • Get BusinessRetrieve one business by ID. Location PITs must be provisioned with the HighLevel permission: `businesses.readonly`.
  • Get Businesses by LocationReturn one offset-paginated page of businesses for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `businesses.readonly`.
  • List Calendar ResourcesList calendar resources by resource type and location ID (Services V1) Location PITs must be provisioned with the HighLevel permission: `calendars/resources.readonly`.
  • Get notificationFind Event notification by notificationId Location PITs must be provisioned with the HighLevel permission: `calendars/events.readonly`.
  • List user availability scheduleRetrieve user availability schedules based on various filters including location, calendar, and user. Supports pagination. Location PITs must be provisioned with the HighLevel permission: `calendars.r
  • Get AppointmentGet appointment by ID Location PITs must be provisioned with the HighLevel permission: `calendars/events.readonly`.
  • Get NotesGet Appointment Notes Location PITs must be provisioned with the HighLevel permission: `calendars/events.readonly`.
  • Get Blocked SlotsGet 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 CalendarGet calendar by ID Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.
  • Get Calendar EventsGet 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 ResourceGet calendar resource by ID (Services V1) Location PITs must be provisioned with the HighLevel permission: `calendars/resources.readonly`.
  • Get CalendarsGet all calendars in a location. Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.
  • Get event calendar availability scheduleRetrieve 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 permis
  • Get notificationsGet 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 provisione
  • Get GroupsGet all calendar groups in a location. Location PITs must be provisioned with the HighLevel permission: `calendars/groups.readonly`.
  • Get user availability scheduleRetrieve 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 perm
  • Get Service Booking by IDGet a specific service booking by ID Location PITs must be provisioned with the HighLevel permission: `calendars/events.readonly`.
  • Get Service BookingsRetrieve 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.readonl
  • Get Service by IDGet service by ID. Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.
  • Get Service Location by IDGet service location by ID Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.
  • Get Service LocationsGet all service locations Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.
  • Get ServicesGet all services in a location. Location PITs must be provisioned with the HighLevel permission: `calendars.readonly`.
  • Get Free SlotsGet 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 th
  • Get CampaignsReturn campaigns for the connected HighLevel location, optionally filtered by status. Location PITs must be provisioned with the HighLevel permission: `campaigns.readonly`.
  • Get Chat WidgetReturns a single chat widget by ID from the connected sub-account. Location PITs must be provisioned with the HighLevel permission: `chat-widget.readonly`.
  • Get Public Chat Widget ConfigReturn a chat widget's public configuration by widget ID. No endpoint-specific provider permission was evidenced beyond a valid Location token.
  • List Chat WidgetsReturns chat widgets for the connected sub-account with pagination and optional filters. Location PITs must be provisioned with the HighLevel permission: `chat-widget.readonly`.
  • Get All NotesGet All Notes Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.
  • Get all TasksGet all Tasks Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.
  • Get Appointments for ContactGet Appointments for Contact Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.
  • Get ContactRetrieves a contact by its unique identifier. Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.
  • Get Contacts By BusinessIdGet Contacts By BusinessId Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.
  • Get Duplicate ContactGet 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 searc
  • Get NoteGet Note Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.
  • Get TaskGet Task Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.
  • Search ContactsSearch contacts using advanced filters and return one cursor-controlled page. Location PITs must be provisioned with the HighLevel permission: `contacts.readonly`.
  • Get Action by IDRetrieves 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
  • Get AgentRetrieves 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: `conve
  • Get the generation detailsRetrieves 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 t
  • List Actions for an AgentList for actions for an agent Location PITs must be provisioned with the HighLevel permission: `conversation-ai.readonly`.
  • Search AgentsSearch 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 P
  • Download transcription by Message IDDownload the recording transcription for a message by passing the message id Location PITs must be provisioned with the HighLevel permission: `conversations/message.readonly`.
  • Export messages by location IDReturn 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 ConversationGet the conversation details based on the conversation ID Location PITs must be provisioned with the HighLevel permission: `conversations.readonly`.
  • Get email by IdGet email by Id Location PITs must be provisioned with the HighLevel permission: `conversations/message.readonly`.
  • Get message by message idGet message by message id. Location PITs must be provisioned with the HighLevel permission: `conversations/message.readonly`.
  • Get Recording by Message IDGet the recording for a message by passing the message id Location PITs must be provisioned with the HighLevel permission: `conversations/message.readonly`.
  • Get messages by conversation idGet messages by conversation id. Location PITs must be provisioned with the HighLevel permission: `conversations/message.readonly`.
  • Get transcription by Message IDGet the recording transcription for a message by passing the message id Location PITs must be provisioned with the HighLevel permission: `conversations/message.readonly`.
  • Search ConversationsReturn 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`.
  • Get Custom Field / Folder By IDGet 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: `loc
  • Get Custom Fields By Object KeyList 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`.
  • Get Bulk Action Campaign by IDGet one bulk-action campaign from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.readonly`.
  • Get Campaign StatisticsGet statistics for an email, workflow, or bulk-action campaign. Location PITs must be provisioned with the HighLevel permission: `emails/stats.readonly`.
  • Get Email Campaign by IDGet one email campaign from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.readonly`.
  • Get Email Template by IDGet one email template from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.readonly`.
  • Get Workflow Campaign by IDGet one workflow campaign from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.readonly`.
  • List Bulk Action CampaignsReturn one page of bulk-action campaigns for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.readonly`.
  • List Email CampaignsReturn one page of email campaigns for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.readonly`.
  • List templatesReturn one page of email templates and folders for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.readonly`.
  • List Workflow CampaignsReturn one page of workflow campaigns for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.readonly`.
  • Get File by SlugGet 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 creden
  • Get FormsReturn 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
  • Get Forms SubmissionsReturn 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:
  • Fetch Redirects ListReturn one offset-based page of URL redirects for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `funnels/redirect.readonly`.
  • Fetch List of FunnelsReturn one offset-based page of funnels for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `funnels/funnel.readonly`.
  • Fetch List of Funnel PagesReturn one offset-based page of pages belonging to a HighLevel funnel. Location PITs must be provisioned with the HighLevel permission: `funnels/page.readonly`.
  • Fetch Count of Funnel PagesCount pages belonging to a HighLevel funnel, optionally filtered by name. Location PITs must be provisioned with the HighLevel permission: `funnels/pagecount.readonly`.
  • Get Ad AccountReturn one ad account or the selected account details for one ad platform. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get Ad Campaign ReportingReturn reporting metrics for one Facebook or Google ad campaign. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get Ad Platform IntegrationReturn the Location's integration state for one ad platform. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get Ad Platform UserReturn the current user from one connected ad platform. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get Ad ReportingReturn aggregate reporting metrics for one connected ad platform. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Generate Estimate NumberGet the next estimate number for the given location. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.readonly`.
  • Generate Invoice NumberGet the next invoice number for the given location. Location PITs must be provisioned with the HighLevel permission: `invoices.readonly`.
  • Get invoiceGet 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 permissio
  • Get an scheduleAPI to get an schedule by schedule id. Location PITs must be provisioned with the HighLevel permission: `invoices/schedule.readonly`.
  • Get Invoice SettingsGet the invoice settings for the given location. Location PITs must be provisioned with the HighLevel permission: `invoices.readonly`.
  • Get an templateAPI to get an template by template id. Location PITs must be provisioned with the HighLevel permission: `invoices/template.readonly`.
  • List EstimatesGet a paginated list of estimates. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.readonly`.
  • List Estimate TemplatesGet a list of estimate templates or a specific template by ID. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.readonly`.
  • List invoicesAPI to get list of invoices. Location PITs must be provisioned with the HighLevel permission: `invoices.readonly`.
  • List schedulesAPI to get list of schedules. Location PITs must be provisioned with the HighLevel permission: `invoices/schedule.readonly`.
  • List templatesAPI to get list of templates. Location PITs must be provisioned with the HighLevel permission: `invoices/template.readonly`.
  • Preview Estimate TemplateGet a preview of an estimate template. Location PITs must be provisioned with the HighLevel permission: `invoices/estimate.readonly`.
  • List Knowledge Base Crawler URLsReturn one page of crawled website URLs. Location PITs require `knowledge-bases.readonly`.
  • Get Knowledge Base Crawler StatusGet crawler operation status. Location PITs require `knowledge-bases.readonly`.
  • Get Knowledge BaseGet a knowledge base by ID. Location PITs require `knowledge-bases.readonly`.
  • List Knowledge BasesReturn one page of knowledge bases for the connected location. Location PITs require `knowledge-bases.readonly`.
  • List Knowledge Base FAQsReturn one page of FAQs. Location PITs require `knowledge-bases.readonly`.
  • Get Link by IDGet a single trigger link by ID from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `links.readonly`.
  • Get LinksGet all trigger links in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `links.readonly`.
  • Search Trigger LinksReturn one offset-based page of trigger links matching a search query. Location PITs must be provisioned with the HighLevel permission: `links.readonly`.
  • List Ad AccountsList 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 no
  • List Ad ReportsList 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 t
  • Get Email, SMS, or WhatsApp TemplatesReturn 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 permiss
  • Get Conversation ChannelGet SMS or email channel providers configured for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations.readonly`.
  • Get Custom FieldGet one custom field from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.readonly`.
  • Get Custom FieldsList custom fields owned by the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.readonly`.
  • Get Custom ValueGet one custom value from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customValues.readonly`.
  • Get Custom ValuesList custom values owned by the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customValues.readonly`.
  • Get Sub-Account (Formerly Location)Get the Location bound to the connected HighLevel account. Location PITs must be provisioned with the HighLevel permission: `locations.readonly`.
  • Get TagsList tags owned by the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/tags.readonly`.
  • Get Recurring Task By IdGet Recurring Task By Id Location PITs must be provisioned with the HighLevel permission: `recurring-tasks.readonly`.
  • Get Tag by IDGet one tag from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/tags.readonly`.
  • Fetch TimezonesFetch the available timezones for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations.readonly`.
  • Task Search FilterReturn one offset-based page of tasks from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/tasks.readonly`.
  • Check Wallet FundsCheck whether the connected HighLevel sub-account has sufficient wallet funds to be charged.
  • Get Marketplace Installer DetailsGet company, Location, user, and installation details associated with the current HighLevel OAuth token for an app.
  • Get Wallet ChargeGet the details of one HighLevel wallet charge by charge ID.
  • List Wallet ChargesReturn one page of wallet charges visible to the connected HighLevel Location, with optional billing and date filters.
  • Get List of Files / FoldersFetch files and folders from the connected HighLevel location's media storage. Location PITs must be provisioned with the HighLevel permission: `medias.readonly`.
  • List Location ObjectsList standard and custom object schemas for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `objects/schema.readonly`.
  • Get Object Schema by KeyRetrieve an object schema by key or ID, optionally including its fields. Location PITs must be provisioned with the HighLevel permission: `objects/schema.readonly`.
  • Get Object RecordRetrieve a business or custom object record by ID. Location PITs must be provisioned with the HighLevel permission: `objects/record.readonly`.
  • Search Object RecordsReturn one page of business or custom object records matching a search expression. Location PITs must be provisioned with the HighLevel permission: `objects/record.readonly`.
  • Get lost reasonGet lost reason. Location PITs must be provisioned with the HighLevel permission: `opportunities.readonly`.
  • Get OpportunityGet Opportunity. Location PITs must be provisioned with the HighLevel permission: `opportunities.readonly`.
  • Get PipelineRetrieve one pipeline, including its stages and configuration. Location PITs must have `pipelines.readonly`.
  • Get PipelinesGet Pipelines. Location PITs must be provisioned with the HighLevel permission: `opportunities.readonly`.
  • Search OpportunitiesSearch opportunities based on combinations of advanced filters. Location PITs must be provisioned with the HighLevel permission: `opportunities.readonly`.
  • Search OpportunitySearch Opportunity. Location PITs must be provisioned with the HighLevel permission: `opportunities.readonly`.
  • Fetch Custom Payment Provider ConfigFetch 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 permiss
  • Get CouponRetrieve 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 HighLev
  • Get Order by IDRetrieve one order by ID from the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/orders.readonly`.
  • Get Subscription by IDRetrieve one payment subscription by ID from the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/subscriptions.readonly`.
  • Get Transaction by IDRetrieve one payment transaction by ID from the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/transactions.readonly`.
  • List CouponsReturn one offset page of coupons for the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/coupons.readonly`.
  • List White-label Integration ProvidersReturn 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 Order FulfillmentList fulfillment history for one order in the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/orders.readonly`.
  • List Order NotesList notes for one payment order in the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/orders.readonly`.
  • List OrdersReturn 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.r
  • List SubscriptionsReturn one offset page of subscriptions for the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/subscriptions.readonly`.
  • List TransactionsReturn one offset page of payment transactions for the connected Location. Location PITs must be provisioned with the HighLevel permission: `payments/transactions.readonly`.
  • List Active NumbersList 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. L
  • List Number PoolsList 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 permissio
  • List Available Phone NumbersSearch 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 p
  • List InventoryThe "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.
  • Get Price by ID for a ProductThe "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 si
  • Get Product by IDThe "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.
  • Fetch Product CollectionsFetch product collections for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `products/collection.readonly`.
  • Get Details about individual product collectionGet Details about individual product collection Location PITs must be provisioned with the HighLevel permission: `products/collection.readonly`.
  • Fetch Product ReviewsAPI to fetch the Product Reviews Location PITs must be provisioned with the HighLevel permission: `products.readonly`.
  • Fetch Product Store StatsAPI 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`.
  • Fetch Review Count as per statusAPI to fetch the Review Count as per status Location PITs must be provisioned with the HighLevel permission: `products.readonly`.
  • List Prices for a ProductThe "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 p
  • List ProductsThe "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. Th
  • List Proposal DocumentsReturn 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
  • List Proposal TemplatesReturn 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
  • Search Ad TargetingSearch targeting options on Facebook Ads, Google Ads, or LinkedIn Ads. Location PITs must be provisioned with the HighLevel permission: `adPublishing.readonly`.
  • Get all categories with their queue statusReturns 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/c
  • Get scheduled posts calendar viewReturns 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.
  • Fetch calendar view for an edit sessionRetrieves 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 H
  • Fetch a category queue by IDRetrieves 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 permis
  • Fetch items from a queueReturns 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.re
  • Fetch category queues for a locationRetrieves 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/
  • Fetch slot information for queue itemsReturns 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.
  • Get AccountsGet list of accounts and groups Location PITs must be provisioned with the HighLevel permission: `socialplanner/account.readonly`.
  • Get categories by idRetrieve a specific category by its ID Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.readonly`.
  • Get categories by location idRetrieve all categories for a specific location with optional search and pagination Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.readonly`.
  • List comments for a post or threadPaginated list of comments scoped to a post (`parentId` = postId) or a comment thread (`parentId` = commentId). Use `skip`/`limit` for pagination, `sortBy` for ordering, `originIds` to filter by conne
  • Get CSV PostGet details of a specific CSV import including its posts Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.readonly`.
  • Get Available Accounts (Step 2 of 3)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, T
  • Get postGet post Location PITs must be provisioned with the HighLevel permission: `socialplanner/post.readonly`.
  • Get postsGet Social Planner posts. Use a narrow `from_date`/`to_date` window to recover an immediately published post when `SOCIAL_PLANNER_CREATE_POST` succeeds without returning a post ID. Location PITs must
  • Get Social Media StatisticsRetrieve analytics data for multiple social media accounts. Supports custom date ranges for both the current period and a comparison period. If no date ranges are provided, defaults to the last 7 days
  • Get tags by idsRetrieve specific tags by their IDs Location PITs must be provisioned with the HighLevel permission: `socialplanner/tag.readonly`.
  • Get tags by location idRetrieve all tags for a specific location with optional search and pagination Location PITs must be provisioned with the HighLevel permission: `socialplanner/tag.readonly`.
  • Get Upload StatusGet the status of all CSV imports for a location Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.readonly`.
  • Get Available Shipping RatesCalculate available shipping-rate quotes without changing provider state. HighLevel rejects amount_available=true, so omit it. A whole-country zone shadows state-specific zones, including when the who
  • Get Shipping CarrierGet a shipping carrier by ID. Location PITs require `store/shipping.readonly`.
  • Get Shipping RateGet a shipping rate by ID. Location PITs require `store/shipping.readonly`.
  • Get Shipping ZoneGet a shipping zone by ID. Location PITs require `store/shipping.readonly`.
  • Get Store SettingsGet store settings for the connected location. Location PITs require `store/setting.readonly`.
  • List Shipping CarriersList shipping carriers. Location PITs require `store/shipping.readonly`.
  • List Shipping RatesReturn one page of shipping rates. Location PITs require `store/shipping.readonly`.
  • List Shipping ZonesReturn one page of shipping zones. Location PITs require `store/shipping.readonly`.
  • Get SurveysReturn one offset-based page of surveys for the connected HighLevel location. Pass `next_cursor` back as `skip` to retrieve the next page. Location PITs must be provisioned with the HighLevel permissi
  • Get Surveys SubmissionsReturn one page of survey 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
  • Get UserRetrieve one HighLevel user by ID. Location PITs must be provisioned with the HighLevel permission: `users.readonly`.
  • Search UsersSearch users belonging to the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permissions: `locations.readonly`, `users.readonly`.
  • Get Voice AI Agent ActionRetrieve one action configured for a Voice AI agent in the connected HighLevel Location. Voice AI availability may require product entitlement. Location PITs must be provisioned with the HighLevel per
  • Get Voice AI AgentRetrieve one Voice AI agent owned by the connected HighLevel Location. Voice AI availability may depend on the Location's subscription or activation. Location PITs must be provisioned with the HighLev
  • List Voice AI AgentsList Voice AI agents in the connected HighLevel Location. Returns one page and an opaque continuation cursor; access may require Voice AI entitlement. Location PITs must be provisioned with the HighLe
  • Get Voice AI Call LogRetrieve one Voice AI call log owned by the connected HighLevel Location. Voice AI dashboard access may require product entitlement. Location PITs must be provisioned with the HighLevel permission: `v
  • List Voice AI Call LogsList Voice AI call logs in the connected HighLevel Location with documented filters, sorting, and one-page continuation. Access may require entitlement. Location PITs must be provisioned with the High
  • Get WorkflowReturn the workflows available to the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `workflows.readonly`.

Held for approval by default (changes and sends)

Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 316 actions.

  • Add custom audience memberAdd a member to a Facebook custom audience Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Batch update audience membersQueue an asynchronous job to add, remove, or replace Facebook custom-audience members via CSV or smart lists. HighLevel does not validate the audience or smart-list IDs before returning `success:true`
  • Create conversation formCreate a new Facebook conversation lead form. HighLevel exposes no delete counterpart for conversation forms. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Create page lead formCreate a new lead form on a Facebook page. is_draft=true always creates a new local draft; draft_form_id does not update an existing draft, and drafts cannot be deleted through this toolkit. Location
  • Delete adPermanently delete a Facebook ad. Unlike campaign and ad-set deletion, this is a hard delete and a repeated delete returns not found. Location PITs must be provisioned with the HighLevel permission: `
  • Delete ad setArchive a Facebook ad set and remove its ads. This is a soft delete: the ad set may remain readable with publishingStatus=ARCHIVED. Location PITs must be provisioned with the HighLevel permission: `ad
  • Delete campaignArchive a Facebook campaign and its ad sets. This is a soft delete: Get campaign continues to return the campaign with publishingStatus=ARCHIVED, and repeated deletes may still return success=true. Lo
  • Delete custom audienceDelete a Facebook custom audience by ID Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Delete Facebook integrationRemove the Facebook ad integration from a location Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Delete page connectionRemove a Facebook page connection from a location. HighLevel does not validate page_id before returning success=true, so success confirms request acceptance, not that the page existed or was disconnec
  • Duplicate adDuplicate an existing Facebook ad Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Duplicate ad setDuplicate an existing Facebook ad set Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
Show all 316
  • Duplicate campaignDuplicate an existing Facebook campaign Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Pause adPause a published Facebook ad. Draft or otherwise unpublished ads cannot be paused. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Pause ad setPause 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 campaignPause a published Facebook campaign. Draft or otherwise unpublished campaigns cannot be paused. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Publish campaignPublish a Facebook campaign and push it live to Facebook Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Remove custom audience memberRemove a member from a Facebook custom audience Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Resume adResume a paused Facebook ad. The ad must already be published and paused. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Resume ad setResume 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 campaignResume a paused Facebook campaign. The campaign must already be published and paused. Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Set default pageSet 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.
  • Update custom audienceUpdate name or description of a Facebook custom audience Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Upsert adCreate 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: `adPublishin
  • Upsert adsetCreate 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 o
  • Upsert campaignCreate 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: `ad
  • Upsert conversion pixelCreate 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 update
  • Create offline user list jobCreate 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 ex
  • Delete conversionSoft-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
  • Delete segmentDelete 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.wr
  • Publish adPublish a Google ad and push it live Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Upsert assetsCreate 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 eithe
  • Upsert audienceCreate 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
  • Upsert conversionCreate 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
  • Upsert segmentCreate or update a Google Ads audience segment Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Create lead formCreate a new LinkedIn lead gen form for an ad account Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Publish ad campaign groupPublish a LinkedIn ad campaign group and push it live Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Update ad statusPause or resume a LinkedIn ad, campaign, or ad group Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Upsert ad campaign groupCreate or update a LinkedIn ad campaign group with campaigns and ads Location PITs must be provisioned with the HighLevel permission: `adPublishing.write`.
  • Create AgentCreate an Agent Studio agent with an initial staging version. Location PITs must be provisioned with the HighLevel permission: `agent-studio.write`.
  • Delete AgentPermanently delete an Agent Studio agent and all of its versions. Location PITs must be provisioned with the HighLevel permission: `agent-studio.write`.
  • Execute AgentExecute 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 provisio
  • Promote to ProductionIrreversibly promote an Agent Studio draft version to production. Location PITs must be provisioned with the HighLevel permission: `agent-studio.write`.
  • Update Agent MetadataUpdate an Agent Studio agent's name, description, or status. Location PITs must be provisioned with the HighLevel permission: `agent-studio.write`.
  • Update AgentUpdate 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 glob
  • Create associationCreate a user-defined association between supported HighLevel object types. Location PITs must be provisioned with the HighLevel permission: `associations.write`.
  • Create relationCreate 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 High
  • Delete associationPermanently 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 mu
  • Delete relationPermanently delete one relation between associated records. Location PITs must be provisioned with the HighLevel permission: `associations/relation.write`.
  • Update associationUpdate the first- and second-object labels of an association definition. Location PITs must be provisioned with the HighLevel permission: `associations.write`.
  • Create blog postCreate a blog post in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `blogs/post.write`.
  • Update blog postUpdate an existing blog post in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `blogs/post-update.write`.
  • Create a new brand boardCreate 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 Brand VoiceCreate a brand voice in the connected location. Location PITs require `brand-boards/voices.write`.
  • Delete a Brand BoardDelete a brand board from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `brand-boards/design-kit.write`.
  • Delete Brand VoiceDelete a brand voice after explicit confirmation. Location PITs require `brand-boards/voices.write`.
  • Set Default Brand VoiceSet the location's default brand voice, replacing the previous default, after explicit confirmation. Location PITs require `brand-boards/voices.write`.
  • Update a Brand BoardUpdate an existing brand board in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `brand-boards/design-kit.write`.
  • Update Brand VoiceUpdate a brand voice after explicit confirmation. Location PITs require `brand-boards/voices.write`.
  • Create BusinessCreate a business in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `businesses.write`.
  • Delete BusinessPermanently delete a business by ID. Location PITs must be provisioned with the HighLevel permission: `businesses.write`.
  • Update BusinessUpdate editable details of an existing business by ID. Location PITs must be provisioned with the HighLevel permission: `businesses.write`.
  • Apply user availability schedule to a calendarAssociate 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 appointmentCreate 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.wr
  • Create NoteCreate 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 provi
  • Create Block SlotCreate 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 CalendarCreate calendar in a location. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.
  • Create Calendar GroupCreate Calendar Group Location PITs must be provisioned with the HighLevel permission: `calendars/groups.write`.
  • Create Calendar ResourceCreate calendar resource by resource type (Services V1) Location PITs must be provisioned with the HighLevel permission: `calendars/resources.write`.
  • Create event calendar availability scheduleCreate 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 HighLe
  • Create notificationCreate 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.wri
  • Create user availability scheduleCreate new schedule with specified rules, timezone, location, user and calendar associations. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.
  • Create Service BookingCreate a new service booking Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.
  • Create ServiceCreate new service in a location. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.
  • Create Service LocationCreate a new service location Location PITs must be provisioned with the HighLevel permission: `calendars.write`.
  • Delete NoteDelete Note Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.
  • Delete CalendarDelete calendar by ID Location PITs must be provisioned with the HighLevel permission: `calendars.write`.
  • Delete Calendar ResourceDelete calendar resource by ID (Services V1) Location PITs must be provisioned with the HighLevel permission: `calendars/resources.write`.
  • Delete EventDelete event by ID Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.
  • Delete NotificationDelete notification Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.
  • Delete GroupDelete Group Location PITs must be provisioned with the HighLevel permission: `calendars/groups.write`.
  • Delete user availability schedulePermanently 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 Service BookingDelete a service booking by ID Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.
  • Delete ServiceDelete 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 PIT
  • Delete Service LocationDelete a service location by ID Location PITs must be provisioned with the HighLevel permission: `calendars.write`.
  • Disable GroupDisable Group Location PITs must be provisioned with the HighLevel permission: `calendars/groups.write`.
  • Update AppointmentUpdate appointment Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.
  • Update Block SlotUpdate block slot by ID Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.
  • Update GroupUpdate Group by group ID Location PITs must be provisioned with the HighLevel permission: `calendars/groups.write`.
  • Remove user availability schedule from a calendarRemove 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 NoteUpdate Note Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.
  • Update CalendarUpdate 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 mus
  • Update Calendar ResourceUpdate calendar resource by ID (Services V1) Location PITs must be provisioned with the HighLevel permission: `calendars/resources.write`.
  • Update event calendar availability scheduleUpdate 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 perm
  • Update notificationUpdate Event notification by id Location PITs must be provisioned with the HighLevel permission: `calendars/events.write`.
  • Update user availability scheduleModify 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: `
  • Update Service BookingUpdate 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.wr
  • Update ServiceUpdate service by ID. Location PITs must be provisioned with the HighLevel permission: `calendars.write`.
  • Update Service LocationUpdate an existing service location Location PITs must be provisioned with the HighLevel permission: `calendars.write`.
  • Validate group slugValidate if group slug is available or not. Location PITs must be provisioned with the HighLevel permission: `calendars/groups.write`.
  • Clone Chat WidgetCreates a copy of a chat widget in the connected sub-account. Location PITs must be provisioned with the HighLevel permission: `chat-widget.write`.
  • Create Chat WidgetCreates a new chat widget for the connected sub-account. Location PITs must be provisioned with the HighLevel permission: `chat-widget.write`.
  • Delete Chat WidgetSoft-deletes a chat widget from the connected sub-account. Location PITs must be provisioned with the HighLevel permission: `chat-widget.write`.
  • Patch Chat WidgetPartially updates a chat widget in the connected sub-account. Location PITs must be provisioned with the HighLevel permission: `chat-widget.write`.
  • Update Chat WidgetFully 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
  • Add Contact to CampaignAdd contact to Campaign Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Add Contact to WorkflowAdd Contact to Workflow Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Add FollowersAdd Followers Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Add TagsAdd Tags Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Bulk Update Contact BusinessSubmit 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`,
  • Bulk Update Contact TagsAdd 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 o
  • Create ContactCreate a new contact Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Create NoteCreate Note Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Create TaskCreate Task Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Delete ContactDelete Contact Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Delete Contact from WorkflowDelete Contact from Workflow Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Delete NoteDelete Note Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Delete TaskDelete Task Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Remove Contact From CampaignRemove Contact From Campaign Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Remove Contact From Every CampaignRemoves the contact from every campaign it is enrolled in. Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Remove FollowersRemove Followers Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Remove TagsRemove Tags Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Update ContactUpdate a contact using contactId Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Update NoteUpdate Note Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Update TaskUpdate Task Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Update Task CompletedUpdate Task Completed Location PITs must be provisioned with the HighLevel permission: `contacts.write`.
  • Upsert ContactThe 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 atte
  • Attach Action to AgentCreates 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. Loc
  • Create an AgentCreates 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 Hig
  • Remove Action from AgentPermanently 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`. Ex
  • Delete AgentDeletes 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:
  • Update ActionUpdates 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 permis
  • Update AgentFully 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 permissi
  • Update Followup SettingsUpdate 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
  • Add an inbound messagePost the necessary fields for the API to add a new inbound message. Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.
  • Add an external outbound callPost the necessary fields for the API to add a new outbound call. Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.
  • Add message attachmentsSet 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
  • Cancel a scheduled email message.Post the messageId for the API to delete a scheduled email message. Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.
  • Cancel a scheduled message.Post the messageId for the API to delete a scheduled message. Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.
  • Create ConversationCreates a new conversation with the data provided Location PITs must be provisioned with the HighLevel permission: `conversations.write`.
  • Delete ConversationDelete the conversation details based on the conversation ID Location PITs must be provisioned with the HighLevel permission: `conversations.write`.
  • Agent/Ai-Bot is typing a message indicator for live chatSet 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 visi
  • Send a new messageSend 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,
  • Update ConversationUpdate the conversation details based on the conversation ID Location PITs must be provisioned with the HighLevel permission: `conversations.write`.
  • Update email message statusUpdate 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` OAut
  • Update message statusPost the necessary fields for the API to update message status. Location PITs must be provisioned with the HighLevel permission: `conversations/message.write`.
  • Upload file attachmentsPost 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
  • Import CoursesImport course products into the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `courses.write`.
  • Create Ad Platform IntegrationConnect 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 con
  • Create Custom FieldCreate 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.wri
  • Create Custom Field FolderCreate 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`.
  • Delete Custom Field By IDPermanently 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:
  • Delete Custom Field FolderPermanently delete a custom field folder from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.
  • Update Custom Field By IDUpdate 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 permis
  • Update Custom Field Folder NameRename 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 permi
  • Delete Ad Account ConnectionDisconnect 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,
  • Email VerificationVerify 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 lo
  • Create Email CampaignCreate an email campaign draft without scheduling or sending it. Location PITs must be provisioned with the HighLevel permission: `emails/campaigns.write`.
  • Create an email templateCreate a new email template in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.write`.
  • Create a template folderCreate an email-template folder in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.write`.
  • Delete CampaignDelete 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. Loca
  • Delete a templatePermanently delete one email template from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.write`.
  • Import an email templateImport an email template from a supported provider URL into the connected location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.write`.
  • Schedule CampaignStart 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 em
  • Update Email CampaignUpdate 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 an email templateUpdate selected fields of an email template in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `emails/templates.write`.
  • Upload Files to Custom FieldsUpload 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: `
  • Create RedirectCreate 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/redir
  • Delete Redirect By IDPermanently delete a URL redirect from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `funnels/redirect.write`.
  • Update Redirect By IDUpdate the destination and action of an existing HighLevel URL redirect. Location PITs must be provisioned with the HighLevel permission: `funnels/redirect.write`.
  • Manage Auto payment for an schedule invoiceAPI 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
  • Cancel an scheduled invoiceAPI 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
  • Create Estimate TemplateCreate 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 th
  • Create InvoiceAPI 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 High
  • Create Invoice from EstimateCreate 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 pro
  • Create Invoice ScheduleAPI 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 fut
  • Create templateCreate 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
  • Create New EstimateCreate 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
  • Delete EstimateDelete 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;
  • Delete Estimate TemplateDelete 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 irre
  • Delete invoicePermanently 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 High
  • Delete scheduleAPI 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 can
  • Delete templatePermanently 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.
  • Record a manual payment for an invoiceRecord 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 financia
  • Schedule an schedule invoiceAPI 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. Thi
  • Send EstimateAPI 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
  • Send invoiceAPI 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 o
  • Create & SendCreate 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 s
  • Update scheduled recurring invoiceReplace 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
  • Update EstimateUpdate 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 be
  • Update estimate last visited atUpdate 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 becaus
  • Update Estimate TemplateUpdate 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 w
  • Update invoiceUpdate 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 change
  • Update Invoice Last Visited AtMark an invoice as last visited in the connected Location. Location PITs must be provisioned with the HighLevel permission: `invoices.write`.
  • Update Invoice Late Fees ConfigurationReplace 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 w
  • Update scheduleReplace 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
  • Update templateUpdate an invoice template by ID. HighLevel nulls attachments, tipsConfiguration, paymentMethods, and automaticTaxesEnabled on every update, even when they are sent. Review currency, amounts, taxes, d
  • Update Template Late Fees ConfigurationReplace 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 th
  • Update Template Payment Methods ConfigurationReplace 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 permissi
  • Void invoiceVoid 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 f
  • Create Knowledge Base FAQCreate an FAQ after explicit confirmation. Location PITs require `knowledge-bases.write`.
  • Create Knowledge BaseCreate a knowledge base after explicit confirmation. Location PITs require `knowledge-bases.write`.
  • Delete Knowledge Base FAQIdempotently delete an FAQ after explicit confirmation; deleting an already-deleted FAQ is treated as successful. Location PITs require `knowledge-bases.write`.
  • Delete Knowledge BaseDelete a knowledge base after explicit confirmation. Location PITs require `knowledge-bases.write`.
  • Delete Trained Knowledge Base URLsIdempotently delete trained pages after explicit confirmation; repeated deletion may still report a positive deletedCount. Location PITs require `knowledge-bases.write`.
  • Discover Website for Knowledge BaseStart website discovery after explicit confirmation. Location PITs require `knowledge-bases.write`.
  • Train Discovered Knowledge Base URLsQueue 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 prog
  • Update Knowledge Base FAQUpdate an FAQ after explicit confirmation. Location PITs require `knowledge-bases.write`.
  • Update Knowledge BaseUpdate a knowledge base after explicit confirmation. Location PITs require `knowledge-bases.write`.
  • Create LinkCreate a trigger link in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: `links.write`.
  • Delete LinkPermanently delete a trigger link by ID. Location PITs must be provisioned with the HighLevel permission: `links.write`.
  • Update LinkUpdate a trigger link's name and redirect destination. Location PITs must be provisioned with the HighLevel permission: `links.write`.
  • Create Custom FieldCreate a custom field in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.
  • Create Custom ValueCreate a custom value in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customValues.write`.
  • Create Recurring TaskCreate Recurring Task Location PITs must be provisioned with the HighLevel permission: `recurring-tasks.write`. Explicit confirmation is required before this mutation is sent.
  • Create TagCreate a tag in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/tags.write`.
  • Delete Custom FieldDelete a custom field from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.
  • Delete Custom ValueDelete a custom value from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customValues.write`.
  • Delete Recurring TaskDelete Recurring Task Location PITs must be provisioned with the HighLevel permission: `recurring-tasks.write`. Explicit confirmation is required before this mutation is sent.
  • Delete TagDelete a tag from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/tags.write`.
  • Update Custom FieldUpdate 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. Locatio
  • Update Custom ValueUpdate a custom value in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customValues.write`.
  • Update Recurring TaskUpdate Recurring Task Location PITs must be provisioned with the HighLevel permission: `recurring-tasks.write`. Explicit confirmation is required before this mutation is sent.
  • Update TagRename a tag in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/tags.write`.
  • Upload File to Custom FieldsUpload a file to a custom field for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: `locations/customFields.write`.
  • Create Wallet ChargeCreate 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 Wallet ChargeDelete a wallet charge. This is a destructive billing operation with real wallet consequences and requires explicit confirmation.
  • Uninstall Marketplace ApplicationUninstall an application from the connected HighLevel Location. This removes the application's access and stops its functionality, so explicit confirmation is required.
  • Bulk Delete / Trash Files or FoldersDelete 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 th
  • Bulk Update Files / FoldersRename 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.wri
  • Create Media FolderCreate a folder in the connected Location's media storage. Location PITs must be provisioned with the HighLevel permission: `medias.write`.
  • Delete File or FolderDelete a file or folder from the connected HighLevel location's media storage. Location PITs must be provisioned with the HighLevel permission: `medias.write`.
  • Update File / FolderRename one file or folder in the connected Location's media storage. Location PITs must be provisioned with the HighLevel permission: `medias.write`.
  • Upload File into Media StorageUpload a file or import a hosted file into HighLevel media storage. Location PITs must be provisioned with the HighLevel permission: `medias.write`.
  • Create Object RecordCreate a business or custom object record with schema-defined fields. Location PITs must be provisioned with the HighLevel permission: `objects/record.write`.
  • Delete Object RecordPermanently delete a business or custom object record by ID. Location PITs must be provisioned with the HighLevel permission: `objects/record.write`.
  • Update Object SchemaUpdate 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_proper
  • Update Object RecordUpdate 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: `
  • Add FollowersAdd 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 u
  • Create OpportunityCreate 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 PipelineCreate 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 OpportunityDelete 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
  • Delete PipelinePermanently delete a pipeline and every opportunity in all its stages. This is irreversible and requires explicit confirmation. Location PITs must have `pipelines.write`.
  • Remove FollowersAllows removal of one or all followers from an opportunity. Location PITs must be provisioned with the HighLevel permission: `opportunities.write`.
  • Update OpportunityUpdate Opportunity. Location PITs must be provisioned with the HighLevel permission: `opportunities.write`.
  • Update Opportunity StatusUpdate Opportunity Status. Location PITs must be provisioned with the HighLevel permission: `opportunities.write`.
  • Update PipelineUpdate 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 OpportunityUpsert Opportunity. Location PITs must be provisioned with the HighLevel permission: `opportunities.write`.
  • Create CouponCreate a promotional coupon. applyToFuturePaymentsConfig is ignored unless applyToFuturePayments is true. Review discount type and value, eligible products, dates, usage limits, and future subscriptio
  • Create Custom Payment IntegrationCreate 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 w
  • Create White-label Integration ProviderCreate 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 provisione
  • Create Order FulfillmentCreate 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 Hi
  • Update Custom Provider CapabilitiesSet whether the connected Location's custom payment provider supports subscription schedules. Confirm downstream recurring-billing behavior before disabling support. Location PITs must be provisioned
  • Delete CouponPermanently 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 permis
  • Delete Custom Payment IntegrationPermanently 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. Th
  • Disconnect Custom Payment Provider ConfigDisconnect 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. Locati
  • Record Order PaymentRecord 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 ca
  • Update CouponReplace an existing coupon's promotional terms. applyToFuturePaymentsConfig is ignored unless applyToFuturePayments is true. Confirm the coupon ID, discount, dates, limits, eligible products, and futu
  • Purchase Number for LocationPurchase 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 ac
  • Bulk Edit Products and PricesEdit 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.
  • Bulk Update ProductsBulk-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
  • Bulk Update Product ReviewsUpdate one or multiple product reviews: status, reply, etc. Location PITs must be provisioned with the HighLevel permission: `products.write`.
  • Create Price for a ProductThe "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
  • Create ProductThe "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 pa
  • Create Product CollectionCreate a new Product Collection for a specific location Location PITs must be provisioned with the HighLevel permission: `products/collection.write`.
  • Delete Price by ID for a ProductThe "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. Locat
  • Delete Product by IDThe "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 HighLev
  • Delete Product CollectionDelete specific product collection with Id :collectionId Location PITs must be provisioned with the HighLevel permission: `products/collection.write`.
  • Delete Product ReviewDelete specific product review Location PITs must be provisioned with the HighLevel permission: `products.write`.
  • Update Product Display PrioritiesSet 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.
  • Update InventoryThe 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 th
  • Update Price by ID for a ProductReplace 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, shippi
  • Update Product by IDUpdate 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 Product CollectionUpdate a specific product collection with Id :collectionId Location PITs must be provisioned with the HighLevel permission: `products/collection.write`.
  • Update Product ReviewUpdate status, reply, etc of a particular review Location PITs must be provisioned with the HighLevel permission: `products.write`.
  • Update Product Store InclusionAPI to update the status of products in a particular store Location PITs must be provisioned with the HighLevel permission: `products.write`.
  • Send Proposal DocumentIrreversibly send an existing proposal or contract to external recipients for the connected HighLevel location. Review the document, recipients, sender, and delivery medium before calling. Availabilit
  • Create or Send Proposal from TemplateCreate 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 creat
  • Connect Account (Step 3 of 3)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
  • Bulk Delete Social Planner PostsIdempotently 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 `delete
  • Clone a queue itemDuplicates 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`. Expli
  • Create a comment or replyCreate 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
  • Like a commentLike 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-t
  • Create a new category queueCreates 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/categor
  • Delete AccountDelete account and account from group Location PITs must be provisioned with the HighLevel permission: `socialplanner/account.write`.
  • Delete CSVDelete a CSV import and all its associated posts Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.write`.
  • Delete CSV PostDelete a specific post from a CSV import Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.write`.
  • Delete an active post and schedule the next oneDeletes 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: `socialpl
  • Unlike a commentRemove 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,
  • Delete PostSoft-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 li
  • Delete an item from a queueDeletes 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
  • Discard edit session changesCancels 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 conf
  • Reset an item in a queueReset a staged queue item to its original state. For a live item with no original staged version, HighLevel deletes the item instead of restoring it. Location PITs must be provisioned with the HighLev
  • Save edit session changesApplies all staged changes to the live queue and closes the edit session. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.write`. Explicit confirmation is requ
  • Set AccountsSet social media accounts for a CSV import to publish posts to Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.write`.
  • Start CSV FinalizeFinalize a CSV import and schedule all posts for publishing Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.write`.
  • Start or resume an edit sessionCreates a draft copy of queue items for editing. Starting another session for the same queue silently expires the previous session, so reuse the returned session ID until changes are saved or discarde
  • Update queue settings or statusUpdates queue status (active/paused/deleted), time slots, or skip dates. Location PITs must be provisioned with the HighLevel permission: `socialplanner/category.write`. Explicit confirmation is requi
  • Upload CSVUpload a CSV file containing social media posts for bulk scheduling Location PITs must be provisioned with the HighLevel permission: `socialplanner/csv.write`.
  • Create Shipping CarrierCreate a shipping carrier after explicit confirmation. Location PITs require `store/shipping.write`.
  • Create Shipping RateCreate a shipping rate after explicit confirmation. For carrier rates, HighLevel overwrites the supplied rate name with the selected carrier's name. Location PITs require `store/shipping.write`.
  • Create Shipping ZoneCreate a shipping zone after explicit confirmation. Location PITs require `store/shipping.write`.
  • Delete Shipping CarrierDelete a shipping carrier after explicit confirmation. Location PITs require `store/shipping.write`.
  • Delete Shipping RateDelete a shipping rate after explicit confirmation. Location PITs require `store/shipping.write`.
  • Delete Shipping ZoneDelete a shipping zone after explicit confirmation. Location PITs require `store/shipping.write`.
  • Update Shipping CarrierUpdate a shipping carrier after explicit confirmation. Location PITs require `store/shipping.write`.
  • Update Shipping RateUpdate a shipping rate after explicit confirmation. HighLevel resets is_carrier_rate to false when it is omitted, so resend is_carrier_rate and shipping_carrier_id when updating a carrier rate. For ca
  • Update Shipping ZoneUpdate a shipping zone after explicit confirmation. Location PITs require `store/shipping.write`.
  • Delete UserQueue deletion of an existing HighLevel user. Location PITs must be provisioned with the HighLevel permission: `users.write`.
  • Update UserUpdate non-password fields of an existing HighLevel user. Location PITs must be provisioned with the HighLevel permission: `users.write`.
  • Create Voice AI Agent ActionCreate a behavior or capability for an existing Voice AI agent in the connected HighLevel Location. This mutates the agent and may require Voice AI entitlement. Location PITs must be provisioned with
  • Create Voice AI AgentCreate a Voice AI agent in the connected HighLevel Location. This changes the Location and may require Voice AI subscription entitlement or activation. Location PITs must be provisioned with the HighL
  • Delete Voice AI Agent ActionPermanently remove an action and its configuration from a Voice AI agent in the connected HighLevel Location. This operation cannot be undone. Location PITs must be provisioned with the HighLevel perm
  • Delete Voice AI AgentPermanently delete a Voice AI agent and its configuration from the connected HighLevel Location. This operation is destructive and cannot be undone. Location PITs must be provisioned with the HighLeve
  • Update Voice AI AgentPartially update a Voice AI agent in the connected HighLevel Location. Only provided fields change; this mutation may require Voice AI entitlement. Location PITs must be provisioned with the HighLevel
  • Update Voice AI Agent ActionReplace an existing Voice AI agent action configuration in the connected HighLevel Location. This mutates call behavior and may require entitlement. Location PITs must be provisioned with the HighLeve

Changes wait in Needs you

Changes and sends in HighLevel Location are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.

How approvals work

HighLevel Location questions

Can an agent change data in HighLevel Location on its own?

Not by default. Changes and sends in HighLevel Location are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.

What can an agent read in HighLevel Location?

This connector lists 233 read actions. Reads run at once, without waiting for approval.

How does HighLevel Location connect?

It connects with OAuth 2.0 or bearer token. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.

Bring HighLevel Location to your agents.

Book a discovery call