rakazo
6.2k
Get started

HighLevel Location

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

554 actionsSign in with HighLevel Location

Connect HighLevel Location

What your bot can do in HighLevel Location

Looks up

  • Check blog URL slugCheck whether a URL slug is already used by a blog post in the connected HighLevel Location.
  • Check Wallet FundsCheck whether the connected HighLevel sub-account has sufficient wallet funds to be charged.
  • Download transcription by Message IDDownload the recording transcription for a message by passing the message id Location PITs must be provisioned with the HighLevel…
  • Export messages by location IDReturn one page of messages for the connected HighLevel location, with a cursor for continuation.
  • Fetch a category queue by IDRetrieves the details of a single category queue by its unique ID.
  • Fetch calendar view for an edit sessionRetrieves a calendar preview of scheduled posts based on draft items within an edit session.
  • 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.
  • Fetch Count of Funnel PagesCount pages belonging to a HighLevel funnel, optionally filtered by name.
  • Fetch Custom Payment Provider ConfigFetch the custom payment-provider configuration for the connected Location.
  • Fetch items from a queueReturns paginated queue items.
Show 223 more
  • Fetch List of Funnel PagesReturn one offset-based page of pages belonging to a HighLevel funnel.
  • Fetch List of FunnelsReturn one offset-based page of funnels for the connected HighLevel Location.
  • Fetch Product CollectionsFetch product collections for the connected HighLevel Location.
  • Fetch Product ReviewsAPI to fetch the Product Reviews Location PITs must be provisioned with the HighLevel permission.
  • 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…
  • Fetch Redirects ListReturn one offset-based page of URL redirects for the connected HighLevel Location.
  • Fetch Review Count as per statusAPI to fetch the Review Count as per status Location PITs must be provisioned with the HighLevel permission.
  • Fetch slot information for queue itemsReturns paginated slot information (scheduledDateTime, isSkipped) for queue items.
  • Fetch TimezonesFetch the available timezones for the connected HighLevel Location.
  • Generate Estimate NumberGet the next estimate number for the given location.
  • Generate Invoice NumberGet the next invoice number for the given location.
  • Get AccountsGet list of accounts and groups Location PITs must be provisioned with the HighLevel permission.
  • Get Action by IDRetrieves detailed information about a specific action using its unique identifier.
  • Get Ad AccountReturn one ad account or the selected account details for one ad platform.
  • Get ad campaign groupRetrieve a LinkedIn ad campaign group by ID Location PITs must be provisioned with the HighLevel permission.
  • Get Ad Campaign ReportingReturn reporting metrics for one Facebook or Google ad campaign.
  • Get Ad Platform IntegrationReturn the Location's integration state for one ad platform.
  • Get Ad Platform UserReturn the current user from one connected ad platform.
  • Get Ad ReportingReturn aggregate reporting metrics for one connected ad platform.
  • Get AffiliateRetrieve a single affiliate by id for a location.
  • Get AgentGet one active Agent Studio agent and all of its non-deleted versions.
  • Get AgentRetrieves a specific AI agent by its ID.
  • Get all categories with their queue statusReturns categories with status.
  • Get All NotesGet All Notes Location PITs must be provisioned with the HighLevel permission.
  • Get all TasksGet all Tasks Location PITs must be provisioned with the HighLevel permission.
  • Get an scheduleAPI to get an schedule by schedule id.
  • Get an templateAPI to get an template by template id.
  • Get AppointmentGet appointment by ID Location PITs must be provisioned with the HighLevel permission.
  • Get Appointments for ContactGet Appointments for Contact Location PITs must be provisioned with the HighLevel permission.
  • Get assetsRetrieve Google Ads creative assets for a location Location PITs must be provisioned with the HighLevel permission.
  • Get association by IDGet a system- or user-defined association by its ID.
  • Get association by key nameGet a standard or user-defined association definition by its key name.
  • Get associations by object keyGet association definitions for a contact, opportunity, or custom-object key.
  • Get audience by IDRetrieve a specific Google Ads combined audience by ID Location PITs must be provisioned with the HighLevel permission.
  • Get audiencesRetrieve Google Ads combined audiences for a location Location PITs must be provisioned with the HighLevel permission.
  • Get Available Accounts (Step 2 of 3)Step 2 of the Social Planner OAuth flow.
  • Get Available Shipping RatesCalculate available shipping-rate quotes without changing provider state.
  • Get Blocked SlotsGet blocked slots for exactly one owner.
  • Get Brand BoardRetrieve one brand board by ID from the connected HighLevel location.
  • Get Brand BoardsReturn one page of brand boards for the connected HighLevel location.
  • Get Brand VoiceGet a brand voice from the connected location.
  • Get Bulk Action Campaign by IDGet one bulk-action campaign from the connected HighLevel location.
  • Get BusinessRetrieve one business by ID.
  • Get Businesses by LocationReturn one offset-paginated page of businesses for the connected HighLevel location.
  • Get CalendarGet calendar by ID Location PITs must be provisioned with the HighLevel permission.
  • Get Calendar EventsGet calendar events for exactly one owner.
  • Get Calendar ResourceGet calendar resource by ID (Services V1) Location PITs must be provisioned with the HighLevel permission.
  • Get CalendarsGet all calendars in a location.
  • Get campaign group reportingRetrieve reporting metrics for a specific LinkedIn campaign group Location PITs must be provisioned with the HighLevel permission.
  • Get Campaign StatisticsGet statistics for an email, workflow, or bulk-action campaign.
  • Get campaign with linked entitiesRetrieve a Facebook campaign with its linked adsets and ads Location PITs must be provisioned with the HighLevel permission.
  • Get CampaignsReturn campaigns for the connected HighLevel location, optionally filtered by status.
  • Get categories by idRetrieve a specific category by its ID Location PITs must be provisioned with the HighLevel permission.
  • Get categories by location idRetrieve all categories for a specific location with optional search and pagination Location PITs must be provisioned with the HighLevel…
  • Get Chat WidgetReturns a single chat widget by ID from the connected sub-account.
  • Get ContactRetrieves a contact by its unique identifier.
  • Get Contacts By BusinessIdGet Contacts By BusinessId Location PITs must be provisioned with the HighLevel permission.
  • Get ConversationGet the conversation details based on the conversation ID Location PITs must be provisioned with the HighLevel permission.
  • Get Conversation ChannelGet SMS or email channel providers configured for the connected HighLevel Location.
  • Get conversation formsRetrieve Facebook conversation lead forms for a location Location PITs must be provisioned with the HighLevel permission.
  • Get conversion by IDRetrieve a specific Google Ads conversion action by ID Location PITs must be provisioned with the HighLevel permission.
  • Get conversion goalsRetrieve Google Ads conversion goals for a location Location PITs must be provisioned with the HighLevel permission.
  • Get conversion pixelsRetrieve Facebook conversion pixels for a location.
  • Get conversionsRetrieve Google Ads conversion actions for a location Location PITs must be provisioned with the HighLevel permission.
  • Get CouponRetrieve coupon details by ID for the connected Location.
  • Get CSV PostGet details of a specific CSV import including its posts Location PITs must be provisioned with the HighLevel permission.
  • Get custom audience by IDRetrieve a specific Facebook custom audience by its ID Location PITs must be provisioned with the HighLevel permission.
  • Get custom audiencesRetrieve Facebook custom audiences for a location.
  • Get Custom FieldGet one custom field from the connected HighLevel Location.
  • Get Custom Field / Folder By IDGet a custom field or folder by ID.
  • Get Custom FieldsList custom fields owned by the connected HighLevel Location.
  • Get Custom Fields By Object KeyList custom fields and folders for an object key in the connected HighLevel location.
  • Get Custom ValueGet one custom value from the connected HighLevel Location.
  • Get Custom ValuesList custom values owned by the connected HighLevel Location.
  • Get Details about individual product collectionGet Details about individual product collection Location PITs must be provisioned with the HighLevel permission.
  • Get Duplicate ContactGet Duplicate Contact.
  • Get email by IdGet email by Id Location PITs must be provisioned with the HighLevel permission.
  • Get Email Campaign by IDGet one email campaign from the connected HighLevel location.
  • Get Email Template by IDGet one email template from the connected HighLevel location.
  • Get Email, SMS, or WhatsApp TemplatesReturn one offset-based page of templates from the connected HighLevel Location.
  • Get entitiesList Facebook campaigns, ad sets, or ads that exist on Meta.
  • Get entitiesRetrieve Google-side campaigns, ad groups, or ads through the current AD_MANAGER path.
  • Get event calendar availability scheduleRetrieve the availability schedule for a specific event calendar.
  • Get Facebook Campaign Publishing ProgressReturn the current Meta publishing step counts and completion state for a Facebook campaign.
  • Get Facebook pagesRetrieve Facebook pages associated with the connected account Location PITs must be provisioned with the HighLevel permission.
  • Get File by SlugGet metadata and a short-lived signed download URL for a HighLevel file share slug.
  • Get FormsReturn one offset-based page of forms for the connected HighLevel location.
  • Get Forms SubmissionsReturn one page of form submissions for the connected HighLevel location.
  • Get Free SlotsGet free slots for a calendar between a date range.
  • Get Google Campaign by IDRetrieve a specific Google Ads campaign by ID, including its ad groups and ad content.
  • Get GroupsGet all calendar groups in a location.
  • Get Instagram accounts for pageRetrieve Instagram accounts linked to a specific Facebook page Location PITs must be provisioned with the HighLevel permission.
  • Get invoiceGet an invoice by ID.
  • Get Invoice SettingsGet the invoice settings for the given location.
  • Get keyword ideasRetrieve keyword suggestions for Google Ads campaigns Location PITs must be provisioned with the HighLevel permission.
  • Get Knowledge BaseGet a knowledge base by ID.
  • Get Knowledge Base Crawler StatusGet crawler operation status.
  • Get lead form by IDRetrieve a specific published or draft Facebook lead form by ID.
  • Get lead formsRetrieve LinkedIn lead gen forms for an ad account Location PITs must be provisioned with the HighLevel permission.
  • Get Link by IDGet a single trigger link by ID from the connected HighLevel location.
  • Get LinksGet all trigger links in the connected HighLevel location.
  • Get List of Files / FoldersFetch files and folders from the connected HighLevel location's media storage.
  • Get lost reasonGet lost reason.
  • Get Marketplace Installer DetailsGet company, Location, user, and installation details associated with the current HighLevel OAuth token for an app.
  • Get message by message idGet message by message id.
  • Get messages by conversation idGet messages by conversation id.
  • Get NoteGet Note Location PITs must be provisioned with the HighLevel permission.
  • Get NotesGet Appointment Notes Location PITs must be provisioned with the HighLevel permission.
  • Get notificationFind Event notification by notificationId Location PITs must be provisioned with the HighLevel permission.
  • Get notificationsGet calendar notifications.
  • Get Object RecordRetrieve a business or custom object record by ID.
  • Get Object Schema by KeyRetrieve an object schema by key or ID, optionally including its fields.
  • Get OpportunityGet Opportunity.
  • Get Order by IDRetrieve one order by ID from the connected Location.
  • Get page lead formsRetrieve lead forms for a Facebook page.
  • Get PipelineRetrieve one pipeline, including its stages and configuration.
  • Get PipelinesGet Pipelines.
  • Get postGet post Location PITs must be provisioned with the HighLevel permission.
  • Get postsGet Social Planner posts.
  • 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…
  • Get Product by IDThe "Get Product by ID" API allows to retrieve information for a specific product using its unique identifier.
  • Get Public Chat Widget ConfigReturn a chat widget's public configuration by widget ID.
  • Get Recording by Message IDGet the recording for a message by passing the message id Location PITs must be provisioned with the HighLevel permission.
  • Get Recurring Task By IdGet Recurring Task By Id Location PITs must be provisioned with the HighLevel permission.
  • Get relations by record IDReturn a page of relations for a record, optionally filtered by association IDs.
  • Get scheduled posts calendar viewReturns scheduled posts from active queues within a date range.
  • Get segment by IDRetrieve a specific Google Ads audience segment by ID Location PITs must be provisioned with the HighLevel permission.
  • Get segmentsRetrieve Google Ads audience segments for a location Location PITs must be provisioned with the HighLevel permission.
  • Get Service Booking by IDGet a specific service booking by ID Location PITs must be provisioned with the HighLevel permission.
  • Get Service BookingsRetrieve service bookings for a location within a given date range, with an optional service location filter.
  • Get Service by IDGet service by ID.
  • Get Service Location by IDGet service location by ID Location PITs must be provisioned with the HighLevel permission.
  • Get Service LocationsGet all service locations Location PITs must be provisioned with the HighLevel permission.
  • Get ServicesGet all services in a location.
  • Get Shipping CarrierGet a shipping carrier by ID.
  • Get Shipping RateGet a shipping rate by ID.
  • Get Shipping ZoneGet a shipping zone by ID.
  • Get Social Media StatisticsRetrieve analytics data for multiple social media accounts.
  • Get Store SettingsGet store settings for the connected location.
  • Get Sub-Account (Formerly Location)Get the Location bound to the connected HighLevel account.
  • Get Subscription by IDRetrieve one payment subscription by ID from the connected Location.
  • Get SurveysReturn one offset-based page of surveys for the connected HighLevel location.
  • Get Surveys SubmissionsReturn one page of survey submissions for the connected HighLevel location.
  • Get Tag by IDGet one tag from the connected HighLevel Location.
  • Get TagsList tags owned by the connected HighLevel Location.
  • Get tags by idsRetrieve specific tags by their IDs Location PITs must be provisioned with the HighLevel permission.
  • Get tags by location idRetrieve all tags for a specific location with optional search and pagination Location PITs must be provisioned with the HighLevel…
  • Get target interestsRetrieve affinity and in-market audience options for Google Ads targeting.
  • Get TaskGet Task Location PITs must be provisioned with the HighLevel permission.
  • Get the generation detailsRetrieves detailed information about AI responses including the System Prompt, Conversation history, Knowledge base, website, FAQ chunks,…
  • Get Transaction by IDRetrieve one payment transaction by ID from the connected Location.
  • 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.
  • Get Upload StatusGet the status of all CSV imports for a location Location PITs must be provisioned with the HighLevel permission.
  • Get UserRetrieve one HighLevel user by ID.
  • Get user availability scheduleRetrieve a specific schedule by its unique identifier.
  • Get Voice AI AgentRetrieve one Voice AI agent owned by the connected HighLevel Location.
  • Get Voice AI Agent ActionRetrieve one action configured for a Voice AI agent in the connected HighLevel Location.
  • Get Voice AI Call LogRetrieve one Voice AI call log owned by the connected HighLevel Location.
  • Get Wallet ChargeGet the details of one HighLevel wallet charge by charge ID.
  • Get WorkflowReturn the workflows available to the connected HighLevel location.
  • Get Workflow Campaign by IDGet one workflow campaign from the connected HighLevel location.
  • List Actions for an AgentList for actions for an agent Location PITs must be provisioned with the HighLevel permission.
  • List Active NumbersList one page of active numbers and phone-account state for the connected HighLevel location.
  • List Ad AccountsList ad accounts available through one connected ad platform.
  • List Ad ReportsList published reporting entities for one connected ad platform.
  • List AffiliatesRetrieve the list of affiliates for a location.
  • List AgentsList active Agent Studio agents for the connected Location, one page at a time.
  • List associationsReturn a page of association definitions for the connected Location.
  • List Available Phone NumbersSearch external phone-provider inventory for numbers purchasable by the connected HighLevel location.
  • List blog authorsReturn one offset-based page of blog authors for the connected HighLevel Location.
  • List blog categoriesReturn one offset-based page of blog categories for the connected HighLevel Location.
  • List blog postsReturn one offset-based page of posts for a blog in the connected HighLevel Location.
  • List blogsReturn one offset-based page of blogs for the connected HighLevel Location.
  • List Brand VoicesReturn one page of brand voices for the connected location.
  • List Bulk Action CampaignsReturn one page of bulk-action campaigns for the connected HighLevel location.
  • List Calendar ResourcesList calendar resources by resource type and location ID (Services V1) Location PITs must be provisioned with the HighLevel permission.
  • List Chat WidgetsReturns chat widgets for the connected sub-account with pagination and optional filters.
  • List comments for a post or threadPaginated list of comments scoped to a post (parentId = postId) or a comment thread (parentId = commentId).
  • List CommissionsRetrieve the list of commissions for a location.
  • List CouponsReturn one offset page of coupons for the connected Location.
  • List Email CampaignsReturn one page of email campaigns for the connected HighLevel location.
  • List Estimate TemplatesGet a list of estimate templates or a specific template by ID.
  • List EstimatesGet a paginated list of estimates.
  • List InventoryThe "List Inventory API allows the user to retrieve a paginated list of inventory items.
  • List invoicesAPI to get list of invoices.
  • List Knowledge Base Crawler URLsReturn one page of crawled website URLs.
  • List Knowledge Base FAQsReturn one page of FAQs.
  • List Knowledge BasesReturn one page of knowledge bases for the connected location.
  • List Location ObjectsList standard and custom object schemas for the connected HighLevel location.
  • List Number PoolsList number pools for the connected HighLevel location.
  • List Order FulfillmentList fulfillment history for one order in the connected Location.
  • List Order NotesList notes for one payment order in the connected Location.
  • List OrdersReturn one offset page of orders for the connected Location.
  • List PayoutsRetrieve the list of payouts for a location.
  • List Prices for a ProductThe "List Prices for a Product" API allows retrieving a paginated list of prices associated with a specific product.
  • List ProductsThe "List Products" API allows to retrieve a paginated list of products.
  • List Proposal DocumentsReturn one page of proposal and contract documents for the connected HighLevel location.
  • List Proposal TemplatesReturn one page of proposal and contract templates for the connected HighLevel location.
  • List schedulesAPI to get list of schedules.
  • List Shipping CarriersList shipping carriers.
  • List Shipping RatesReturn one page of shipping rates.
  • List Shipping ZonesReturn one page of shipping zones.
  • List SubscriptionsReturn one offset page of subscriptions for the connected Location.
  • List templatesReturn one page of email templates and folders for the connected HighLevel location.
  • List templatesAPI to get list of templates.
  • List TransactionsReturn one offset page of payment transactions for the connected Location.
  • List user availability scheduleRetrieve user availability schedules based on various filters including location, calendar, and user.
  • List Voice AI AgentsList Voice AI agents in the connected HighLevel Location.
  • List Voice AI Call LogsList Voice AI call logs in the connected HighLevel Location with documented filters, sorting, and one-page continuation.
  • List Wallet ChargesReturn one page of wallet charges visible to the connected HighLevel Location, with optional billing and date filters.
  • List White-label Integration ProvidersReturn one offset page of white-label payment integration providers for the connected Location.
  • List Workflow CampaignsReturn one page of workflow campaigns for the connected HighLevel location.
  • Preview Estimate TemplateGet a preview of an estimate template.
  • Search Ad TargetingSearch targeting options on Facebook Ads, Google Ads, or LinkedIn Ads.
  • Search AgentsSearch AI agents by lowercase name query.
  • Search ContactsSearch contacts using advanced filters and return one cursor-controlled page.
  • Search ConversationsReturn one page of conversations for the connected HighLevel location and an opaque cursor for the next page.
  • Search Object RecordsReturn one page of business or custom object records matching a search expression.
  • Search OpportunitiesSearch opportunities based on combinations of advanced filters.
  • Search OpportunitySearch Opportunity.
  • Search Trigger LinksReturn one offset-based page of trigger links matching a search query.
  • Search UsersSearch users belonging to the connected HighLevel Location.
  • Task Search FilterReturn one offset-based page of tasks from the connected HighLevel Location.

Takes action

  • Add an external outbound callPost the necessary fields for the API to add a new outbound call.
  • Add an inbound messagePost the necessary fields for the API to add a new inbound message.
  • Add Contact to CampaignAdd contact to Campaign Location PITs must be provisioned with the HighLevel permission.
  • Add Contact to WorkflowAdd Contact to Workflow Location PITs must be provisioned with the HighLevel permission.
  • Add custom audience memberAdd a member to a Facebook custom audience Location PITs must be provisioned with the HighLevel permission.
  • Add FollowersAdd Followers 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.
  • Add message attachmentsSet attachments on an existing message (replaces existing).
  • Add TagsAdd Tags Location PITs must be provisioned with the HighLevel permission.
  • Agent/Ai-Bot is typing a message indicator for live chatSet the typing indicator for a conversation started by a live-chat widget visitor.
Show 311 more
  • Apply user availability schedule to a calendarAssociate a calendar with a schedule.
  • Attach Action to AgentCreates and attach a new action for an AI agent.
  • Batch update audience membersQueue an asynchronous job to add, remove, or replace Facebook custom-audience members via CSV or smart lists.
  • Bulk Delete / Trash Files or FoldersDelete or trash multiple files and folders in the connected Location.
  • Bulk Delete Social Planner PostsIdempotently soft-delete up to 50 Social Planner posts from HighLevel.
  • Bulk Edit Products and PricesEdit fields on up to 30 products and nested prices in one request.
  • Bulk Update Contact BusinessSubmit a job to assign one business to up to 50 contacts, or remove their business association with remove_business=true.
  • Bulk Update Contact TagsAdd or remove tags for multiple contacts, including optionally removing all tags.
  • Bulk Update Files / FoldersRename multiple files or folders in the connected Location's media storage.
  • Bulk Update Product ReviewsUpdate one or multiple product reviews.
  • Bulk Update ProductsBulk-update product prices, availability, collections, or currency, or permanently delete products when type is bulk-delete-products.
  • Cancel a scheduled email message.Post the messageId for the API to delete a scheduled email message.
  • Cancel a scheduled message.Post the messageId for the API to delete a scheduled message.
  • Cancel an scheduled invoiceAPI to cancel a scheduled invoice by schedule id.
  • Clone a queue itemDuplicates an existing queue item at a specified order position.
  • Clone Chat WidgetCreates a copy of a chat widget in the connected sub-account.
  • Connect Account (Step 3 of 3)Attach an account returned by SOCIAL_PLANNER_GET_OAUTH_ACCOUNTS (step 2 of the OAuth flow).
  • Create & SendCreate or update a text-to-pay invoice.
  • Create a comment or replyCreate a top-level post comment (isParentThread.
  • Create a new brand boardCreate a brand board with logos, colors, and fonts in the connected HighLevel location.
  • Create a new category queueCreates a queue in draft status for a category.
  • Create a new item in the queueAdds a new post item to a queue.
  • Create a template folderCreate an email-template folder in the connected HighLevel location.
  • Create Ad Platform IntegrationConnect one supported ad platform to the Location using the provider-specific account identifiers.
  • Create AgentCreate an Agent Studio agent with an initial staging version.
  • Create an AgentCreates a new AI agent for the location.
  • Create an email templateCreate a new email template in the connected HighLevel location.
  • Create appointmentCreate an appointment.
  • Create associationCreate a user-defined association between supported HighLevel object types.
  • Create Block SlotCreate a block slot for exactly one owner.
  • Create blog postCreate a blog post in the connected HighLevel Location.
  • Create Brand VoiceCreate a brand voice in the connected location.
  • Create BusinessCreate a business in the connected HighLevel location.
  • Create CalendarCreate calendar in a location.
  • Create Calendar GroupCreate Calendar Group Location PITs must be provisioned with the HighLevel permission.
  • Create Calendar ResourceCreate calendar resource by resource type (Services V1) Location PITs must be provisioned with the HighLevel permission.
  • Create Chat WidgetCreates a new chat widget for the connected sub-account.
  • Create ContactCreate a new contact Location PITs must be provisioned with the HighLevel permission.
  • Create ConversationCreates a new conversation with the data provided Location PITs must be provisioned with the HighLevel permission.
  • Create conversation formCreate a new Facebook conversation lead form.
  • Create CouponCreate a promotional coupon.
  • Create Custom FieldCreate a custom field for a custom object or Company (Business) object in the connected HighLevel location.
  • Create Custom FieldCreate a custom field in the connected HighLevel Location.
  • Create Custom Field FolderCreate a custom field folder for a custom object in the connected HighLevel location.
  • Create Custom Payment IntegrationCreate a custom payment-provider association for the connected Location.
  • Create Custom ValueCreate a custom value in the connected HighLevel Location.
  • Create Email CampaignCreate an email campaign draft without scheduling or sending it.
  • Create Estimate TemplateCreate a new estimate template.
  • Create event calendar availability scheduleCreate or replace the availability schedule for an event calendar.
  • Create InvoiceAPI to create an invoice.
  • Create Invoice from EstimateCreate a new invoice from an existing estimate.
  • Create Invoice ScheduleAPI to create an invoice Schedule.
  • Create Knowledge BaseCreate a knowledge base after explicit confirmation.
  • Create Knowledge Base FAQCreate an FAQ after explicit confirmation.
  • Create lead formCreate a new LinkedIn lead gen form for an ad account Location PITs must be provisioned with the HighLevel permission.
  • Create LinkCreate a trigger link in the connected HighLevel location.
  • Create Media FolderCreate a folder in the connected Location's media storage.
  • Create New EstimateCreate a new estimate.
  • Create NoteCreate an appointment note.
  • Create NoteCreate Note Location PITs must be provisioned with the HighLevel permission.
  • Create notificationCreate Calendar notifications, either one or multiple.
  • Create Object RecordCreate a business or custom object record with schema-defined fields.
  • Create offline user list jobCreate a job to upload users to an existing Google Customer Match list.
  • Create OpportunityCreate an opportunity.
  • Create or Send Proposal from TemplateCreate a proposal or contract from a template for a contact in the connected HighLevel location.
  • Create Order FulfillmentCreate fulfillment history for an order.
  • Create page lead formCreate a new lead form on a Facebook page.
  • Create PipelineCreate a pipeline with at least one stage in the connected HighLevel location.
  • Create postCreate a draft or publish/schedule content on connected external social networks.
  • Create Price for a ProductThe "Create Price for a Product" API allows adding a new price associated with a specific product to the system.
  • Create ProductThe "Create Product" API allows adding a new product to the system.
  • Create Product CollectionCreate a new Product Collection for a specific location Location PITs must be provisioned with the HighLevel permission.
  • Create Recurring TaskCreate Recurring Task Location PITs must be provisioned with the HighLevel permission.
  • Create RedirectCreate a URL redirect for the connected HighLevel Location.
  • Create relationCreate a relation between two records in the association definition's canonical first-object then second-object order.
  • Create ServiceCreate new service in a location.
  • Create Service BookingCreate a new service booking Location PITs must be provisioned with the HighLevel permission.
  • Create Service LocationCreate a new service location Location PITs must be provisioned with the HighLevel permission.
  • Create Shipping CarrierCreate a shipping carrier after explicit confirmation.
  • Create Shipping RateCreate a shipping rate after explicit confirmation.
  • Create Shipping ZoneCreate a shipping zone after explicit confirmation.
  • Create TagCreate a tag in the connected HighLevel Location.
  • Create TaskCreate Task Location PITs must be provisioned with the HighLevel permission.
  • Create templateCreate an invoice template.
  • Create user availability scheduleCreate new schedule with specified rules, timezone, location, user and calendar associations.
  • Create Voice AI AgentCreate a Voice AI agent in the connected HighLevel Location.
  • Create Voice AI Agent ActionCreate a behavior or capability for an existing Voice AI agent in the connected HighLevel Location.
  • Create Wallet ChargeCreate a real wallet charge for the connected HighLevel Location.
  • Create White-label Integration ProviderCreate a Location payment-provider integration backed by Authorize.net or NMI.
  • Delete a Brand BoardDelete a brand board from the connected HighLevel location.
  • Delete a templatePermanently delete one email template from the connected HighLevel location.
  • Delete AccountDelete account and account from group Location PITs must be provisioned with the HighLevel permission.
  • Delete adPermanently delete a Facebook ad.
  • Delete Ad Account ConnectionDisconnect an ad account from one supported ad platform.
  • Delete ad setArchive a Facebook ad set and remove its ads.
  • Delete AgentPermanently delete an Agent Studio agent and all of its versions.
  • Delete AgentDeletes an AI agent permanently.
  • 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.
  • Delete an item from a queueDeletes an item from a specific category queue.
  • Delete associationPermanently delete a user-defined association.
  • Delete Brand VoiceDelete a brand voice after explicit confirmation.
  • Delete BusinessPermanently delete a business by ID.
  • Delete CalendarDelete calendar by ID Location PITs must be provisioned with the HighLevel permission.
  • Delete Calendar ResourceDelete calendar resource by ID (Services V1) Location PITs must be provisioned with the HighLevel permission.
  • Delete campaignArchive a Facebook campaign and its ad sets.
  • Delete CampaignDelete an email campaign.
  • Delete Chat WidgetSoft-deletes a chat widget from the connected sub-account.
  • Delete ContactDelete Contact Location PITs must be provisioned with the HighLevel permission.
  • Delete Contact from WorkflowDelete Contact from Workflow Location PITs must be provisioned with the HighLevel permission.
  • Delete ConversationDelete the conversation details based on the conversation ID Location PITs must be provisioned with the HighLevel permission.
  • Delete conversionSoft-delete a Google Ads conversion action by ID.
  • Delete CouponPermanently delete a coupon.
  • Delete CSVDelete a CSV import and all its associated posts Location PITs must be provisioned with the HighLevel permission.
  • Delete CSV PostDelete a specific post from a CSV import Location PITs must be provisioned with the HighLevel permission.
  • Delete custom audienceDelete a Facebook custom audience by ID Location PITs must be provisioned with the HighLevel permission.
  • Delete Custom FieldDelete a custom field from the connected HighLevel Location.
  • Delete Custom Field By IDPermanently delete a custom field by ID.
  • Delete Custom Field FolderPermanently delete a custom field folder from the connected HighLevel location.
  • Delete Custom Payment IntegrationPermanently delete the connected Location's custom payment-provider association.
  • Delete Custom ValueDelete a custom value from the connected HighLevel Location.
  • Delete EstimateDelete an existing estimate.
  • Delete Estimate TemplateDelete an existing estimate template.
  • Delete EventDelete event by ID Location PITs must be provisioned with the HighLevel permission.
  • Delete Facebook integrationRemove the Facebook ad integration from a location Location PITs must be provisioned with the HighLevel permission.
  • Delete File or FolderDelete a file or folder from the connected HighLevel location's media storage.
  • Delete GroupDelete Group Location PITs must be provisioned with the HighLevel permission.
  • Delete invoicePermanently delete a draft invoice by ID.
  • Delete Knowledge BaseDelete a knowledge base after explicit confirmation.
  • Delete Knowledge Base FAQIdempotently delete an FAQ after explicit confirmation.
  • Delete LinkPermanently delete a trigger link by ID.
  • Delete NoteDelete Note Location PITs must be provisioned with the HighLevel permission.
  • Delete NoteDelete Note Location PITs must be provisioned with the HighLevel permission.
  • Delete NotificationDelete notification Location PITs must be provisioned with the HighLevel permission.
  • Delete Object RecordPermanently delete a business or custom object record by ID.
  • Delete OpportunityDelete Opportunity.
  • Delete page connectionRemove a Facebook page connection from a location.
  • Delete PipelinePermanently delete a pipeline and every opportunity in all its stages.
  • Delete PostSoft-delete one Social Planner post from HighLevel idempotently through the bulk-delete operation.
  • 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…
  • Delete Product by IDThe "Delete Product by ID" API allows deleting a specific product using its unique identifier.
  • Delete Product CollectionDelete specific product collection with Id .
  • Delete Product ReviewDelete specific product review Location PITs must be provisioned with the HighLevel permission.
  • Delete Recurring TaskDelete Recurring Task Location PITs must be provisioned with the HighLevel permission.
  • Delete Redirect By IDPermanently delete a URL redirect from the connected HighLevel Location.
  • Delete relationPermanently delete one relation between associated records.
  • Delete scheduleAPI to delete an schedule by schedule id.
  • Delete segmentDelete a Google Ads audience segment by ID.
  • Delete ServiceDelete a service catalog item by ID.
  • Delete Service BookingDelete a service booking by ID Location PITs must be provisioned with the HighLevel permission.
  • Delete Service LocationDelete a service location by ID Location PITs must be provisioned with the HighLevel permission.
  • Delete Shipping CarrierDelete a shipping carrier after explicit confirmation.
  • Delete Shipping RateDelete a shipping rate after explicit confirmation.
  • Delete Shipping ZoneDelete a shipping zone after explicit confirmation.
  • Delete TagDelete a tag from the connected HighLevel Location.
  • Delete TaskDelete Task Location PITs must be provisioned with the HighLevel permission.
  • Delete templatePermanently delete an invoice template by ID.
  • Delete Trained Knowledge Base URLsIdempotently delete trained pages after explicit confirmation.
  • Delete UserQueue deletion of an existing HighLevel user.
  • Delete user availability schedulePermanently remove a schedule and all its associated rules.
  • Delete Voice AI AgentPermanently delete a Voice AI agent and its configuration from the connected HighLevel Location.
  • Delete Voice AI Agent ActionPermanently remove an action and its configuration from a Voice AI agent in the connected HighLevel Location.
  • Delete Wallet ChargeDelete a wallet charge.
  • Disable GroupDisable Group Location PITs must be provisioned with the HighLevel permission.
  • Discard edit session changesCancels the edit session and deletes all staged changes without affecting the live queue.
  • Disconnect Custom Payment Provider ConfigDisconnect a custom provider's live or test payment configuration.
  • Discover Website for Knowledge BaseStart website discovery after explicit confirmation.
  • Duplicate adDuplicate an existing Facebook ad Location PITs must be provisioned with the HighLevel permission.
  • Duplicate ad setDuplicate an existing Facebook ad set Location PITs must be provisioned with the HighLevel permission.
  • Duplicate campaignDuplicate an existing Facebook campaign Location PITs must be provisioned with the HighLevel permission.
  • Edit postEdit an existing Social Planner post and optionally republish or reschedule it on its connected external networks.
  • Email VerificationVerify an email address or a HighLevel contact's email.
  • Execute AgentExecute an active Agent Studio agent and return its complete non-streaming response.
  • Import an email templateImport an email template from a supported provider URL into the connected location.
  • Import CoursesImport course products into the connected HighLevel location.
  • Like a commentLike a comment by its **Highlevel** comment ID (the _id returned by the list-comments endpoint — not the native platform ID).
  • Manage Auto payment for an schedule invoiceAPI to manage auto payment for a schedule.
  • Patch Chat WidgetPartially updates a chat widget in the connected sub-account.
  • Pause adPause a published Facebook ad.
  • Pause ad setPause a published Facebook ad set.
  • Pause campaignPause a published Facebook campaign.
  • Promote to ProductionIrreversibly promote an Agent Studio draft version to production.
  • Publish adPublish a Google ad and push it live Location PITs must be provisioned with the HighLevel permission.
  • Publish ad campaign groupPublish a LinkedIn ad campaign group and push it live Location PITs must be provisioned with the HighLevel permission.
  • Publish campaignPublish a Facebook campaign and push it live to Facebook Location PITs must be provisioned with the HighLevel permission.
  • Purchase Number for LocationPurchase a phone number for the connected HighLevel location from external provider inventory.
  • Record a manual payment for an invoiceRecord a manual payment against an invoice.
  • Record Order PaymentRecord a real manual payment against an order.
  • Remove Action from AgentPermanently deletes an action.
  • Remove Contact From CampaignRemove Contact From Campaign Location PITs must be provisioned with the HighLevel permission.
  • Remove Contact From Every CampaignRemoves the contact from every campaign it is enrolled in.
  • Remove custom audience memberRemove a member from a Facebook custom audience Location PITs must be provisioned with the HighLevel permission.
  • Remove FollowersRemove Followers Location PITs must be provisioned with the HighLevel permission.
  • Remove FollowersAllows removal of one or all followers from an opportunity.
  • Remove TagsRemove Tags Location PITs must be provisioned with the HighLevel permission.
  • Remove user availability schedule from a calendarRemove a calendar from a schedule.
  • Reset an item in a queueReset a staged queue item to its original state.
  • Resume adResume a paused Facebook ad.
  • Resume ad setResume a paused Facebook ad set.
  • Resume campaignResume a paused Facebook campaign.
  • Save edit session changesApplies all staged changes to the live queue and closes the edit session.
  • Schedule an schedule invoiceAPI to schedule an schedule invoice to start sending to the customer.
  • Schedule CampaignStart or schedule a draft or paused email campaign after validating recipients and schedule configuration.
  • Send a new messageSend an external message to a contact through the selected channel.
  • Send EstimateAPI to send estimate by estimate id.
  • Send invoiceAPI to send invoice by invoice id.
  • Send Proposal DocumentIrreversibly send an existing proposal or contract to external recipients for the connected HighLevel location.
  • Set AccountsSet social media accounts for a CSV import to publish posts to Location PITs must be provisioned with the HighLevel permission.
  • Set Default Brand VoiceSet the location's default brand voice, replacing the previous default, after explicit confirmation.
  • Set default pageSet the default Facebook page for a location.
  • Start CSV FinalizeFinalize a CSV import and schedule all posts for publishing Location PITs must be provisioned with the HighLevel permission.
  • Start or resume an edit sessionCreates a draft copy of queue items for editing.
  • Train Discovered Knowledge Base URLsQueue discovered pages for training after explicit confirmation.
  • Uninstall Marketplace ApplicationUninstall an application from the connected HighLevel Location.
  • 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).
  • Update a Brand BoardUpdate an existing brand board in the connected HighLevel location.
  • Update ActionUpdates an existing action's configuration.
  • Update ad statusPause or resume a LinkedIn ad, campaign, or ad group Location PITs must be provisioned with the HighLevel permission.
  • Update AgentUpdate a specific Agent Studio version.
  • Update AgentFully replace the required personality, goal, and instructions of an existing AI agent.
  • Update Agent MetadataUpdate an Agent Studio agent's name, description, or status.
  • Update an email templateUpdate selected fields of an email template in the connected HighLevel location.
  • Update an item in a queueUpdates the content or variations of a specific item within a category queue.
  • Update AppointmentUpdate appointment Location PITs must be provisioned with the HighLevel permission.
  • Update associationUpdate the first- and second-object labels of an association definition.
  • Update Block SlotUpdate block slot by ID Location PITs must be provisioned with the HighLevel permission.
  • Update blog postUpdate an existing blog post in the connected HighLevel Location.
  • Update Brand VoiceUpdate a brand voice after explicit confirmation.
  • Update BusinessUpdate editable details of an existing business by ID.
  • Update CalendarUpdate calendar by ID.
  • Update Calendar ResourceUpdate calendar resource by ID (Services V1) Location PITs must be provisioned with the HighLevel permission.
  • Update Chat WidgetFully updates a chat widget in the connected sub-account.
  • Update ContactUpdate a contact using contactId Location PITs must be provisioned with the HighLevel permission.
  • Update ConversationUpdate the conversation details based on the conversation ID Location PITs must be provisioned with the HighLevel permission.
  • Update CouponReplace an existing coupon's promotional terms.
  • Update custom audienceUpdate name or description of a Facebook custom audience Location PITs must be provisioned with the HighLevel permission.
  • Update Custom FieldUpdate a custom field in the connected HighLevel Location.
  • Update Custom Field By IDUpdate a custom field by ID in the connected HighLevel location.
  • Update Custom Field Folder NameRename a custom field folder in the connected HighLevel location.
  • Update Custom Provider CapabilitiesSet whether the connected Location's custom payment provider supports subscription schedules.
  • Update Custom ValueUpdate a custom value in the connected HighLevel Location.
  • Update Email CampaignUpdate selected fields of an email campaign draft.
  • Update email message statusUpdate delivery events, per-recipient statuses, and the overall message status for an email sent via a custom conversation provider.
  • Update EstimateUpdate an existing estimate.
  • Update estimate last visited atUpdate an estimate's last-visited timestamp by estimate ID.
  • Update Estimate TemplateUpdate an existing estimate template.
  • Update event calendar availability scheduleUpdate the availability schedule for a specific event calendar.
  • Update File / FolderRename one file or folder in the connected Location's media storage.
  • Update Followup SettingsUpdate followupSettings for one or more advancedFollowup actions.
  • Update GroupUpdate Group by group ID Location PITs must be provisioned with the HighLevel permission.
  • Update InventoryThe Update Inventory API allows the user to bulk update the inventory for multiple items.
  • Update invoiceUpdate an invoice by invoice ID.
  • Update Invoice Last Visited AtMark an invoice as last visited in the connected Location.
  • Update Invoice Late Fees ConfigurationReplace late-fee settings on an invoice in the connected Location.
  • Update Knowledge BaseUpdate a knowledge base after explicit confirmation.
  • Update Knowledge Base FAQUpdate an FAQ after explicit confirmation.
  • Update LinkUpdate a trigger link's name and redirect destination.
  • Update message statusPost the necessary fields for the API to update message status.
  • Update NoteUpdate Note Location PITs must be provisioned with the HighLevel permission.
  • Update NoteUpdate Note Location PITs must be provisioned with the HighLevel permission.
  • Update notificationUpdate Event notification by id Location PITs must be provisioned with the HighLevel permission.
  • Update Object RecordUpdate a standard or custom object record with schema-defined fields.
  • Update Object SchemaUpdate a custom object's labels, description, and searchable fields, or update searchable fields for a standard object.
  • Update OpportunityUpdate Opportunity.
  • Update Opportunity StatusUpdate Opportunity Status.
  • Update PipelineUpdate a pipeline.
  • Update Price by ID for a ProductReplace a product price by ID.
  • Update Product by IDUpdate a product by ID.
  • Update Product CollectionUpdate a specific product collection with Id .
  • Update Product Display PrioritiesSet product display priorities for a store in the connected Location.
  • Update Product ReviewUpdate status, reply, etc of a particular review Location PITs must be provisioned with the HighLevel permission.
  • Update Product Store InclusionAPI to update the status of products in a particular store Location PITs must be provisioned with the HighLevel permission.
  • Update queue settings or statusUpdates queue status (active/paused/deleted), time slots, or skip dates.
  • Update Recurring TaskUpdate Recurring Task Location PITs must be provisioned with the HighLevel permission.
  • Update Redirect By IDUpdate the destination and action of an existing HighLevel URL redirect.
  • Update scheduleReplace an invoice schedule by schedule ID.
  • Update scheduled recurring invoiceReplace the contents of an invoice schedule that is already in scheduled state.
  • Update ServiceUpdate service by ID.
  • Update Service BookingUpdate an existing service booking.
  • Update Service LocationUpdate an existing service location Location PITs must be provisioned with the HighLevel permission.
  • Update Shipping CarrierUpdate a shipping carrier after explicit confirmation.
  • Update Shipping RateUpdate a shipping rate after explicit confirmation.
  • Update Shipping ZoneUpdate a shipping zone after explicit confirmation.
  • Update TagRename a tag in the connected HighLevel Location.
  • Update TaskUpdate Task Location PITs must be provisioned with the HighLevel permission.
  • Update Task CompletedUpdate Task Completed Location PITs must be provisioned with the HighLevel permission.
  • Update templateUpdate an invoice template by ID.
  • Update Template Late Fees ConfigurationReplace an invoice template's late-fee configuration in the connected Location.
  • Update Template Payment Methods ConfigurationReplace payment-method settings on an invoice template in the connected Location.
  • Update UserUpdate non-password fields of an existing HighLevel user.
  • Update user availability scheduleModify an existing schedule by updating its rules, timezone, and name All fields are optional - only provided fields will be updated.
  • Update Voice AI AgentPartially update a Voice AI agent in the connected HighLevel Location.
  • Update Voice AI Agent ActionReplace an existing Voice AI agent action configuration in the connected HighLevel Location.
  • Upload CSVUpload a CSV file containing social media posts for bulk scheduling Location PITs must be provisioned with the HighLevel permission.
  • Upload file attachmentsPost the necessary fields for the API to upload files.
  • Upload File into Media StorageUpload a file or import a hosted file into HighLevel media storage.
  • Upload File to Custom FieldsUpload a file to a custom field for the connected HighLevel Location.
  • Upload Files to Custom FieldsUpload one or more files to file-upload custom fields on a contact in the connected HighLevel location.
  • Upsert adCreate or update a Facebook ad.
  • Upsert ad campaign groupCreate or update a LinkedIn ad campaign group with campaigns and ads Location PITs must be provisioned with the HighLevel permission.
  • Upsert adsetCreate or update a Facebook ad set.
  • Upsert assetsCreate or update Google Ads creative assets.
  • Upsert audienceCreate or update a Google Ads combined audience.
  • Upsert campaignCreate or update a Facebook campaign.
  • Upsert ContactThe Upsert API will adhere to the configuration defined under the "Allow Duplicate Contact" setting at the Location level.
  • Upsert conversionCreate or update a Google Ads conversion action.
  • Upsert conversion pixelCreate or update a Facebook conversion pixel.
  • Upsert Google campaignCreate or update a full Google Ads campaign structure.
  • Upsert OpportunityUpsert Opportunity.
  • Upsert segmentCreate or update a Google Ads audience segment Location PITs must be provisioned with the HighLevel permission.
  • Validate group slugValidate if group slug is available or not.
  • Void invoiceVoid a non-draft invoice by ID without deleting its record.

More sales & crm apps