Skip to main content
The GoHighLevel node adds GoHighLevel operations to your workflows. Add it on the canvas or ask the AI builder for it by name, then pick an operation and fill in its fields. GoHighLevel also includes 74 trigger operations (marked in the tables below) that can start a workflow when something happens in GoHighLevel.
You can wire the GoHighLevel node into an AI agent as a tool provider: the agent calls the operations you allow. See Agent tools.

Credentials

Connect GoHighLevel under Credentials in the node settings. See Connecting credentials for the general flow. Enter the values manually when creating the credential. In GoHighLevel go to Settings → Private Integrations → Create new Integration, choose the scopes you need, and copy the token. Get your credentials here.

Operations

Ad manager

OperationIDDescriptionTrigger
Add custom audience memberfb_add_custom_audience_memberAdd custom audience member
Batch update audience membersfb_batch_update_audience_membersBatch update audience members
Create conversation formfb_create_conversation_formCreate conversation form
Create Facebook integrationfb_create_integrationCreate Facebook integration
Create Google integrationgoogle_create_integrationCreate Google integration
Create lead formli_create_lead_formCreate lead form
Create LinkedIn integrationli_create_integrationCreate LinkedIn integration
Create offline user list jobgoogle_create_offline_user_list_jobCreate offline user list job
Create page lead formfb_create_page_lead_formCreate page lead form
Delete adfb_delete_adDelete ad
Delete ad accountfb_delete_ad_accountDelete ad account
Delete ad accountgoogle_delete_ad_accountDelete ad account
Delete ad accountli_delete_ad_accountDelete ad account
Delete ad setfb_delete_adsetDelete ad set
Delete campaignfb_delete_campaignDelete campaign
Delete conversiongoogle_delete_conversionDelete conversion
Delete custom audiencefb_delete_custom_audienceDelete custom audience
Delete Facebook integrationfb_delete_integrationDelete Facebook integration
Delete page connectionfb_delete_pageDelete page connection
Delete segmentgoogle_delete_segmentDelete segment
Duplicate adfb_duplicate_adDuplicate ad
Duplicate ad setfb_duplicate_adsetDuplicate ad set
Duplicate campaignfb_duplicate_campaignDuplicate campaign
Get ad account detailsfb_get_ad_accountGet ad account details
Get ad account detailsgoogle_get_ad_account_detailsGet ad account details
Get ad account detailsli_get_ad_account_detailsGet ad account details
Get ad accountsfb_get_ad_accountsGet ad accounts
Get ad analyticsli_get_ad_analyticsGet ad analytics
Get ad campaign groupli_get_campaign_groupGet ad campaign group
Get assetsgoogle_get_assetsGet assets
Get audience by IDgoogle_get_audience_by_idGet audience by ID
Get audiencesgoogle_get_audiencesGet audiences
Get campaign group reportingli_get_campaign_group_reportingGet campaign group reporting
Get campaign reportingfb_get_campaign_reportingGet campaign reporting
Get campaign reportinggoogle_get_campaign_reportingGet campaign reporting
Get campaign with linked entitiesfb_get_campaignGet campaign with linked entities
Get conversation formsfb_get_conversation_formsGet conversation forms
Get conversion by IDgoogle_get_conversion_by_idGet conversion by ID
Get conversion goalsgoogle_get_conversion_goalsGet conversion goals
Get conversion pixelsfb_get_pixelsGet conversion pixels
Get conversionsgoogle_get_conversionsGet conversions
Get current Facebook userfb_get_current_userGet current Facebook user
Get current Google usergoogle_get_current_userGet current Google user
Get current LinkedIn userli_get_current_userGet current LinkedIn user
Get custom audience by IDfb_get_custom_audience_by_idGet custom audience by ID
Get custom audiencesfb_get_custom_audiencesGet custom audiences
Get entitiesfb_get_entityGet entities
Get entitiesgoogle_get_entityGet entities
Get Facebook integrationfb_get_integrationGet Facebook integration
Get Facebook pagesfb_get_pagesGet Facebook pages
Get Google ad accountsgoogle_get_ad_accountsGet Google ad accounts
Get Google campaign by IDgoogle_get_campaign_by_idGet Google campaign by ID
Get Google integrationgoogle_get_integrationGet Google integration
Get Instagram accounts for pagefb_get_instagram_accountsGet Instagram accounts for page
Get keyword ideasgoogle_get_keyword_ideasGet keyword ideas
Get lead form by IDfb_get_lead_formGet lead form by ID
Get lead formsli_get_lead_formsGet lead forms
Get LinkedIn ad accountsli_get_ad_accountsGet LinkedIn ad accounts
Get LinkedIn integrationli_get_integrationGet LinkedIn integration
Get page lead formsfb_get_page_lead_formsGet page lead forms
Get reporting datafb_get_reportingGet reporting data
Get reporting datagoogle_get_reportingGet reporting data
Get reporting listfb_get_reporting_listGet reporting list
Get reporting listgoogle_get_reporting_listGet reporting list
Get reporting listli_get_reporting_listGet reporting list
Get segment by IDgoogle_get_segment_by_idGet segment by ID
Get segmentsgoogle_get_segmentsGet segments
Get target interestsgoogle_get_target_interestsGet target interests
Pause adfb_pause_adPause ad
Pause ad setfb_pause_adsetPause ad set
Pause campaignfb_pause_campaignPause campaign
Publish adgoogle_publish_adPublish ad
Publish ad campaign groupli_publish_campaign_groupPublish ad campaign group
Publish campaignfb_publish_campaignPublish campaign
Remove custom audience memberfb_remove_custom_audience_memberRemove custom audience member
Resume adfb_resume_adResume ad
Resume ad setfb_resume_adsetResume ad set
Resume campaignfb_resume_campaignResume campaign
Search targeting optionsfb_search_targetingSearch targeting options
Search targeting optionsgoogle_search_targetingSearch targeting options
Search targeting optionsli_search_targetingSearch targeting options
Set default pagefb_set_default_pageSet default page
Update ad statusli_update_ad_statusUpdate ad status
Update custom audiencefb_update_custom_audienceUpdate custom audience
Upsert adfb_upsert_adUpsert ad
Upsert ad campaign groupli_upsert_campaign_groupUpsert ad campaign group
Upsert adsetfb_upsert_adsetUpsert adset
Upsert assetsgoogle_upsert_assetsUpsert assets
Upsert audiencegoogle_upsert_audienceUpsert audience
Upsert campaignfb_upsert_campaignUpsert campaign
Upsert conversiongoogle_upsert_conversionUpsert conversion
Upsert conversion pixelfb_upsert_pixelUpsert conversion pixel
Upsert Google campaigngoogle_upsert_campaignUpsert Google campaign
Upsert segmentgoogle_upsert_segmentUpsert segment

Affiliate manager

OperationIDDescriptionTrigger
Get Affiliateget_affiliateGet an affiliate by id.
List Affiliateslist_affiliatesList affiliates for a location (sub-account).
List Commissionslist_commissionsList affiliate commissions for a location (sub-account).
List Payoutslist_payoutsList affiliate payouts for a location (sub-account).

Agent studio

OperationIDDescriptionTrigger
Create Agentcreate_studio_agentCreate an agent for a location.
Delete Agentdelete_studio_agentDelete an agent.
Execute Agentexecute_agentExecute an agent with a message.
Execute Agent (Deprecated)execute_agent_deprecatedExecute an agent (deprecated public-api endpoint).
Get Agentget_agent_by_idGet an agent by id.
Get Agent (Deprecated)get_agent_by_id_deprecatedGet an agent by id (deprecated public-api endpoint).
List Agentsget_agentsList agents for a location.
List Agents (Deprecated)get_agents_deprecatedList agents (deprecated public-api endpoint).
Promote to Productionpromote_and_publish_agentPromote an agent version to production and publish.
Update Agentupdate_agent_versionUpdate an agent version.
Update Agent Metadataupdate_agent_metadataUpdate an agent’s metadata.

Associations

OperationIDDescriptionTrigger
Create Associationcreate_associationCreate an association.
Create Relationcreate_relationCreate a relation between two associated records.
Delete Associationdelete_associationDelete an association.
Delete Relationdelete_relationDelete a relation.
Find Associationsfind_associationsGet all associations for a sub-account / location.
Get Association By IDget_association_by_idGet an association by id.
Get Association By Key Nameget_association_key_by_key_nameGet an association by its unique key name.
Get Association By Object Keysget_association_by_object_keysGet an association by object keys.
Get Relations By Recordget_relations_by_record_idGet all relations by record id.
Update Associationupdate_associationUpdate an association by id.

Blogs

OperationIDDescriptionTrigger
Check Blog URL Slugcheck_url_slug_existsCheck whether a blog post url slug already exists for a location.
Create Blog Postcreate_blog_postCreate a blog post.
List Blog Authorsget_all_blog_authors_by_locationList blog authors for a location.
List Blog Categoriesget_all_blog_categories_by_locationList blog categories for a location.
List Blog Postsget_blog_posts_by_blogGet blog posts by blog id.
List Blogsget_blogs_by_locationList blogs (sites) for a location.
Update Blog Postupdate_blog_postUpdate a blog post.

Brand boards

OperationIDDescriptionTrigger
Create Brand Boardcreate_brand_boardCreate a new brand board.
Delete Brand Boarddelete_brand_boardDelete a brand board.
Get Brand Boardget_brand_board_by_idGet a brand board by id.
List Brand Boardsget_brand_boards_by_locationList brand boards for a location (sub-account).
Update Brand Boardupdate_brand_boardUpdate a brand board.

Businesses

OperationIDDescriptionTrigger
Create Businesscreate_businessCreate a business within a location.
Delete Businessdelete_businessDelete a business.
Get Businessget_businessGet a business by id.
List Businessesget_businesses_by_locationList businesses for a location (sub-account).
Update Businessupdate_businessUpdate a business.

Calendars

OperationIDDescriptionTrigger
Add Calendar To Scheduleadd_calendar_to_scheduleApply a user availability schedule to a calendar.
Create Appointmentcreate_appointmentCreate an appointment on a calendar.
Create Appointment Notecreate_appointment_noteCreate a note on an appointment.
Create Availability Schedulecreate_availability_scheduleCreate a user availability schedule.
Create Block Slotcreate_block_slotCreate a block slot.
Create Calendarcreate_calendarCreate a calendar. Complex nested fields (notifications, teamMembers, openHours, availabilities, locationConfigurations, recurring) accept raw JSON strings.
Create Calendar Groupcreate_calendar_groupCreate a calendar group.
Create Calendar Notificationcreate_calendar_notificationCreate calendar notifications. The API accepts a JSON array of notification objects.
Create Calendar Resourcecreate_calendar_resourceCreate a calendar resource.
Delete Appointment Notedelete_appointment_noteDelete a note on an appointment.
Delete Availability Scheduledelete_availability_scheduleDelete a user availability schedule.
Delete Calendardelete_calendarDelete a calendar.
Delete Calendar Eventdelete_calendar_eventDelete a calendar event (appointment or block slot).
Delete Calendar Groupdelete_calendar_groupDelete a calendar group.
Delete Calendar Notificationdelete_calendar_notificationDelete a calendar notification.
Delete Calendar Resourcedelete_calendar_resourceDelete a calendar resource.
Disable/Enable Calendar Groupdisable_calendar_groupEnable or disable a calendar group.
Get Appointmentget_appointmentGet an appointment by event id.
Get Availability Scheduleget_availability_scheduleGet a user availability schedule by id.
Get Blocked Slotsget_blocked_slotsGet blocked slots in a time range.
Get Calendarget_calendarGet a calendar by id.
Get Calendar Eventsget_calendar_eventsGet calendar events in a time range.
Get Calendar Notificationfind_calendar_notificationGet a single calendar notification.
Get Calendar Resourceget_calendar_resourceGet a calendar resource by type and id.
Get Free Slotsget_free_slotsGet free/available slots for a calendar.
List Appointment Notesget_appointment_notesList notes on an appointment.
List Availability Schedulesget_availability_schedulesList user availability schedules.
List Calendar Groupsget_calendar_groupsList calendar groups for a location.
List Calendar Notificationsget_calendar_notificationsList notifications configured on a calendar.
List Calendar Resourceslist_calendar_resourcesList calendar resources of a type.
List Calendarsget_calendarsList calendars for a location.
Remove Calendar From Scheduleremove_calendar_from_scheduleRemove a user availability schedule from a calendar.
Update Appointmentedit_appointmentUpdate an existing appointment.
Update Appointment Noteupdate_appointment_noteUpdate a note on an appointment.
Update Availability Scheduleupdate_availability_scheduleUpdate a user availability schedule.
Update Block Slotedit_block_slotUpdate a block slot.
Update Calendarupdate_calendarUpdate a calendar. Complex nested fields accept raw JSON strings.
Update Calendar Groupupdate_calendar_groupUpdate a calendar group.
Update Calendar Notificationupdate_calendar_notificationUpdate a calendar notification.
Update Calendar Resourceupdate_calendar_resourceUpdate a calendar resource.
Validate Group Slugvalidate_calendar_group_slugValidate a calendar group slug is available.

Campaigns

OperationIDDescriptionTrigger
Get Campaignsget_campaignsList campaigns for a location (sub-account).

Companies

OperationIDDescriptionTrigger
Get Companyget_companyGet a company (agency) by id.

Contacts

OperationIDDescriptionTrigger
Add Contact Followersadd_contact_followersAdd followers to a contact.
Add Contact Tagsadd_contact_tagsAdd tags to a contact.
Add Contact To Campaignadd_contact_to_campaignAdd a contact to a campaign.
Add Contact To Workflowadd_contact_to_workflowAdd a contact to a workflow.
Bulk Add/Remove Contacts From Businessbulk_update_contacts_businessAdd or remove multiple contacts from a business.
Bulk Update Contacts Tagsbulk_update_contacts_tagsBulk add or remove tags across many contacts.
Create Contactcreate_contactCreate a contact.
Create Contact Notecreate_contact_noteCreate a note for a contact.
Create Contact Taskcreate_contact_taskCreate a task for a contact.
Delete Contactdelete_contactDelete a contact.
Delete Contact Notedelete_contact_noteDelete a contact’s note.
Delete Contact Taskdelete_contact_taskDelete a contact’s task.
Get Appointments For Contactget_appointments_for_contactGet appointments for a contact.
Get Contactget_contactGet a contact by id.
Get Contact Noteget_contact_noteGet a single note for a contact.
Get Contact Notesget_contact_notesGet all notes for a contact.
Get Contact Taskget_contact_taskGet a single task for a contact.
Get Contact Tasksget_contact_tasksGet all tasks for a contact.
Get Contacts By Businessget_contacts_by_business_idGet contacts belonging to a business.
Get Duplicate Contactget_duplicate_contactFind a duplicate contact by phone number or email.
List Contactsget_contactsList contacts for a location.
Remove Contact Followersremove_contact_followersRemove followers from a contact.
Remove Contact From Campaignremove_contact_from_campaignRemove a contact from a campaign.
Remove Contact From Every Campaignremove_contact_from_every_campaignRemove a contact from every campaign.
Remove Contact From Workflowremove_contact_from_workflowRemove a contact from a workflow.
Remove Contact Tagsremove_contact_tagsRemove tags from a contact.
Search Contacts (Advanced)search_contacts_advancedAdvanced search for contacts (POST /contacts/search).
Update Contactupdate_contactUpdate a contact.
Update Contact Noteupdate_contact_noteUpdate a contact’s note.
Update Contact Taskupdate_contact_taskUpdate a contact’s task.
Update Contact Task Completedupdate_contact_task_completedSet the completed flag on a contact’s task.
Upsert Contactupsert_contactCreate or update a contact (upsert).

Conversation AI

OperationIDDescriptionTrigger
Create Agentcreate_conversation_ai_agentCreate a Conversation AI agent (employee).
Create Agent Actioncreate_agent_actionAttach an action to a Conversation AI agent.
Delete Agentdelete_conversation_ai_agentDelete a Conversation AI agent.
Delete Agent Actiondelete_agent_actionRemove an action from an agent.
Get Agentget_conversation_ai_agentGet a Conversation AI agent by id.
Get Agent Actionget_agent_action_by_idGet a single agent action by id.
Get Generation Detailsget_generation_detailsGet generation details for a message.
List Agent Actionslist_agent_actionsList the actions attached to an agent.
Search Agentssearch_conversation_ai_agentsSearch Conversation AI agents.
Update Agentupdate_conversation_ai_agentUpdate a Conversation AI agent.
Update Agent Actionupdate_agent_actionUpdate an agent action.
Update Agent Followup Settingsupdate_agent_followup_settingsUpdate an agent’s advanced follow-up settings.

Conversations

OperationIDDescriptionTrigger
Add An Inbound Messageadd_an_inbound_messageAdd an inbound message to a conversation.
Add An Outbound Messageadd_an_outbound_messageAdd an external outbound call message.
Add Message Attachmentsadd_message_attachmentsAdd attachments to an existing message.
Cancel Scheduled Email Messagecancel_scheduled_email_messageCancel a scheduled email message.
Cancel Scheduled Messagecancel_scheduled_messageCancel a scheduled message.
Complete File Uploadcomplete_file_uploadComplete a file upload.
Create Conversationcreate_conversationCreate a conversation.
Create Custom Subtypecreate_custom_subtypeCreate a custom message subtype.
Delete Conversationdelete_conversationDelete a conversation.
Download Message Transcriptiondownload_message_transcriptionDownload a call transcription by message id.
Export Messages By Locationexport_messages_by_locationExport messages for a location.
Get All Custom Subtypesget_all_custom_subtypesList all custom message subtypes for a location.
Get Contact Unsubscription Statusget_contact_unsubscription_statusGet a contact’s unsubscription status.
Get Conversationget_conversationGet a conversation by id.
Get Email By IDget_email_by_idGet an email message by id.
Get Messageget_messageGet a message by id.
Get Message Recordingget_message_recordingGet a call recording by message id.
Get Message Transcriptionget_message_transcriptionGet a call transcription by message id.
Get Messagesget_messagesGet messages for a conversation.
Initiate File Uploadinitiate_file_uploadInitiate a file upload to GCS.
Live Chat Agent Typinglive_chat_agent_typingSend a live-chat agent typing indicator.
Search Conversationssearch_conversationSearch conversations within a location.
Send A New Messagesend_a_new_messageSend a new message.
Send Review Replysend_review_replySend a review reply to Google My Business.
Update Conversationupdate_conversationUpdate a conversation.
Update Custom Subtypeupdate_custom_subtypeUpdate a custom message subtype.
Update Message Statusupdate_message_statusUpdate a message’s delivery status.
Upload File Attachmentsupload_file_attachmentsUpload file attachments (from attachment URLs) to a conversation.
User Subscription Changeuser_subscription_changeChange a user’s subscription (subscribe/unsubscribe).

Courses

OperationIDDescriptionTrigger
Import Coursesimport_coursesImport courses (products) into a location via the courses exporter.

Custom fields

OperationIDDescriptionTrigger
Create Custom Fieldcreate_custom_field_v2Create a custom field.
Create Custom Field Foldercreate_custom_field_folderCreate a custom field folder.
Delete Custom Fielddelete_custom_field_v2Delete a custom field by id.
Delete Custom Field Folderdelete_custom_field_folderDelete a custom field folder.
Get Custom Field / Folder By IDget_custom_field_by_idGet a custom field or folder by id.
Get Custom Fields By Object Keyget_custom_fields_by_object_keyList custom fields for an object key.
Update Custom Fieldupdate_custom_field_v2Update a custom field by id.
Update Custom Field Folderupdate_custom_field_folderUpdate a custom field folder name.

Custom menus

OperationIDDescriptionTrigger
Create Custom Menu Linkcreate_custom_menuCreate a new custom menu link.
Delete Custom Menu Linkdelete_custom_menuDelete a custom menu link.
Get Custom Menu Linkget_custom_menu_by_idFetch a single custom menu link by id.
List Custom Menu Linksget_custom_menusList custom menu links.
Update Custom Menu Linkupdate_custom_menuUpdate an existing custom menu link.

Custom objects

OperationIDDescriptionTrigger
Create Custom Objectcreate_custom_object_schemaCreate a custom object schema.
Create Recordcreate_object_recordCreate an object record.
Delete Recorddelete_object_recordDelete an object record.
Get Object Schemaget_object_schema_by_keyGet an object schema by key / id.
Get Recordget_object_record_by_idGet an object record by id.
List Objectsget_object_by_location_idGet all objects for a location.
Search Recordssearch_object_recordsSearch object records.
Update Object Schemaupdate_custom_objectUpdate an object schema by key / id.
Update Recordupdate_object_recordUpdate an object record.

Email builder

OperationIDDescriptionTrigger
Create Email Templatecreate_email_templateCreate a new email template.
Delete Email Templatedelete_email_templateDelete an email template.
Fetch Email Templatesfetch_email_templatesFetch email templates for a location.
Get Email Campaignsfetch_email_campaignsGet email campaigns/schedules for a location.
Update Email Templateupdate_email_templateUpdate an email template (save builder data).

Email verification

OperationIDDescriptionTrigger
Verify Emailverify_emailVerify an email address or a contact’s email deliverability.

Forms

OperationIDDescriptionTrigger
Get Form Submissionsget_forms_submissionsGet form submissions for a location.
Get Formsget_formsGet forms for a location.
Upload Files to Custom Fieldsupload_to_custom_fieldsUpload files to custom fields on a contact.

Funnels

OperationIDDescriptionTrigger
Count Funnel Pagesget_funnel_pages_countFetch the count of funnel pages for a funnel.
Create Redirectcreate_funnel_redirectCreate a funnel redirect.
Delete Redirectdelete_funnel_redirectDelete a funnel redirect by id.
List Funnel Pagesget_funnel_pagesFetch the list of funnel pages for a funnel.
List Funnelsget_funnelsFetch the list of funnels.
List Redirectsfetch_funnel_redirects_listFetch the list of funnel redirects.
Update Redirectupdate_funnel_redirectUpdate a funnel redirect by id.

Invoices

OperationIDDescriptionTrigger
Auto Payment Invoice Scheduleauto_payment_invoice_scheduleManage auto-payment for an invoice schedule.
Cancel Invoice Schedulecancel_invoice_scheduleCancel an invoice schedule.
Create Estimatecreate_new_estimateCreate a new estimate.
Create Estimate Templatecreate_estimate_templateCreate an estimate template.
Create Invoicecreate_invoiceCreate an invoice.
Create Invoice From Estimatecreate_invoice_from_estimateCreate an invoice from an estimate.
Create Invoice Schedulecreate_invoice_scheduleCreate an invoice schedule (recurring invoice).
Create Invoice Templatecreate_invoice_templateCreate an invoice template.
Delete Estimatedelete_estimateDelete an estimate.
Delete Estimate Templatedelete_estimate_templateDelete an estimate template.
Delete Invoicedelete_invoiceDelete an invoice.
Delete Invoice Scheduledelete_invoice_scheduleDelete an invoice schedule.
Delete Invoice Templatedelete_invoice_templateDelete an invoice template.
Generate Estimate Numbergenerate_estimate_numberGenerate the next estimate number.
Generate Invoice Numbergenerate_invoice_numberGenerate the next invoice number.
Get Invoiceget_invoiceGet an invoice by id.
Get Invoice Scheduleget_invoice_scheduleGet an invoice schedule by id.
Get Invoice Settingsget_invoice_settingsGet invoice settings for a location.
Get Invoice Templateget_invoice_templateGet an invoice template by id.
List Estimate Templateslist_estimate_templatesList estimate templates.
List Estimateslist_estimatesList estimates.
List Invoice Scheduleslist_invoice_schedulesList invoice schedules.
List Invoice Templateslist_invoice_templatesList invoice templates.
List Invoiceslist_invoicesList invoices.
Preview Estimate Templatepreview_estimate_templatePreview an estimate template.
Record Invoice Paymentrecord_invoiceRecord a manual payment against an invoice.
Schedule Invoice Scheduleschedule_invoice_scheduleSchedule an invoice schedule.
Send Estimatesend_estimateSend an estimate.
Send Invoicesend_invoiceSend an invoice.
Text2Pay Invoicetext2pay_invoiceCreate & send a text2pay invoice.
Update And Schedule Invoice Scheduleupdate_and_schedule_invoice_scheduleUpdate and schedule an invoice schedule.
Update Estimateupdate_estimateUpdate an estimate.
Update Estimate Last Visited Atupdate_estimate_last_visited_atUpdate the last-visited-at stat for an estimate.
Update Estimate Templateupdate_estimate_templateUpdate an estimate template.
Update Invoiceupdate_invoiceUpdate an invoice.
Update Invoice Last Visited Atupdate_invoice_last_visited_atUpdate the last-visited-at stat for an invoice.
Update Invoice Late Fees Configupdate_invoice_late_fees_configurationUpdate late-fees configuration for an invoice.
Update Invoice Scheduleupdate_invoice_scheduleUpdate an invoice schedule.
Update Invoice Templateupdate_invoice_templateUpdate an invoice template.
Update Template Late Fees Configupdate_invoice_template_late_fees_configurationUpdate late-fees configuration for an invoice template.
Update Template Payment Methods Configupdate_invoice_payment_methods_configurationUpdate payment-methods configuration for an invoice template.
Void Invoicevoid_invoiceVoid an invoice.

Knowledge base

OperationIDDescriptionTrigger
Create Knowledge Basecreate_knowledge_baseCreate a new knowledge base (max 15 knowledge bases per location).
Create Knowledge Base FAQcreate_knowledge_base_faqCreate a new FAQ inside knowledge base.
Delete Knowledge Basedelete_knowledge_baseDelete a knowledge base.
Delete Knowledge Base FAQdelete_knowledge_base_faqDelete an existing knowledge base FAQ.
Delete Trained Website URLsdelete_trained_urls_for_knowledge_baseDelete trained pages.
Discover Website Pagesdiscover_websiteStart crawling and discover pages for training.
Get Crawling Statusget_crawling_status_for_latest_operationGet crawling status for the latest operation.
Get Knowledge Baseget_knowledge_base_by_idGet knowledge base by ID.
List Knowledge Base FAQslist_knowledge_base_faqsGet all FAQs by knowledge base with pagination support.
List Knowledge Baseslist_all_knowledge_bases_paginatedGet all knowledge bases for a location by location Id (paginated).
List Trained Website URLsget_all_website_urls_data_by_knowledge_baseGet all trained page links by knowledge base.
Train Discovered URLstrain_discovered_urlsTrain discovered website pages and ingest into the knowledge base.
Update Knowledge Baseupdate_knowledge_baseUpdate a knowledge base.
Update Knowledge Base FAQupdate_knowledge_base_faqUpdate an existing knowledge base FAQ.

Locations

OperationIDDescriptionTrigger
Create Custom Fieldcreate_custom_fieldCreate a custom field in a sub-account (location).
Create Custom Valuecreate_custom_valueCreate a custom value in a sub-account (location).
Create Location Tagcreate_location_tagCreate a tag in a sub-account (location).
Create Recurring Taskcreate_recurring_taskCreate a recurring task within a sub-account (location).
Create Sub-Accountcreate_locationCreate a sub-account (location).
Delete Custom Fielddelete_custom_fieldDelete a custom field.
Delete Custom Valuedelete_custom_valueDelete a custom value.
Delete Location Tagdelete_location_tagDelete a location tag.
Delete Recurring Taskdelete_recurring_taskDelete a recurring task.
Delete Sub-Accountdelete_locationDelete a sub-account (location).
Delete Templatedelete_location_templateDelete an email/SMS template.
Get Custom Fieldget_custom_fieldGet a custom field by id.
Get Custom Fieldsget_custom_fieldsGet custom fields for a sub-account (location).
Get Custom Valueget_custom_valueGet a custom value by id.
Get Custom Valuesget_custom_valuesGet custom values for a sub-account (location).
Get Location Tag By IDget_location_tag_by_idGet a location tag by id.
Get Location Tagsget_location_tagsGet tags for a sub-account (location).
Get Recurring Task By IDget_recurring_task_by_idGet a recurring task by id.
Get Sub-Accountget_locationGet a sub-account (location) by id.
Get Templatesget_location_templatesGet all or email/SMS templates for a sub-account (location).
Get Timezonesget_location_timezonesFetch available timezones for a sub-account (location).
Search Location Taskslocation_task_searchSearch tasks within a sub-account (location).
Search Sub-Accountssearch_locationsSearch sub-accounts (locations).
Update Custom Fieldupdate_custom_fieldUpdate a custom field.
Update Custom Valueupdate_custom_valueUpdate a custom value.
Update Location Tagupdate_location_tagUpdate a location tag.
Update Recurring Taskupdate_recurring_taskUpdate a recurring task.
Update Sub-Accountput_locationUpdate a sub-account (location).
Upload Custom Fields Fileupload_custom_fields_fileUpload a file to custom fields (multipart/form-data).

Marketplace

OperationIDDescriptionTrigger
Delete Chargedelete_marketplace_chargeDelete a previously raised charge by id.
Get Chargeget_specific_marketplace_chargeGet a single charge by id.
Get Installer Detailsget_installer_detailsGet installation/installer details for a marketplace app.
Get Rebilling Config For Appget_rebilling_config_for_appGet the rebilling configuration for an app in a location.
Has Fundsmarketplace_has_fundsCheck whether the installation has funds available for charging.
List Chargesget_marketplace_chargesList raised charges, optionally filtered by meter/event/user/date.
Migrate Connectionmigrate_connectionMigrate an external auth connection into a marketplace app installation.
Raise Chargecreate_marketplace_chargeRaise a usage-based (metered) charge for an app installation.
Uninstall Applicationuninstall_applicationUninstall a marketplace app from a company or location.

Media library

OperationIDDescriptionTrigger
Bulk Delete/Trash Files/Foldersbulk_delete_media_objectsBulk soft-delete or trash multiple files and folders.
Bulk Update Files/Foldersbulk_update_media_objectsBulk update metadata or status of multiple files and folders.
Create Foldercreate_media_folderCreate a new folder in the media storage.
Delete File/Folderdelete_media_contentDelete a specific file or folder from media storage.
List Files/Foldersfetch_media_contentGet list of files and folders from the media storage.
Update File/Folderupdate_media_objectUpdate a single file or folder by id.
Upload Fileupload_media_contentUpload a file into media storage. If hosted is true, fileUrl is required; else file is required (max 25 MB).

Opportunities

OperationIDDescriptionTrigger
Add Followersadd_followers_opportunityAdd followers to an opportunity.
Create Opportunitycreate_opportunityCreate an opportunity.
Delete Opportunitydelete_opportunityDelete an opportunity.
Get Lost Reasonsget_opportunity_lost_reasonGet lost reasons for a location.
Get Opportunityget_opportunityGet an opportunity by id.
Get Pipelinesget_opportunity_pipelinesGet pipelines for a location.
Remove Followersremove_followers_opportunityRemove followers from an opportunity.
Search Opportunitiessearch_opportunitySearch opportunities (GET query-param based).
Search Opportunities (Advanced)search_opportunities_advancedSearch opportunities (POST body based, advanced).
Update Opportunityupdate_opportunityUpdate an opportunity.
Update Opportunity Statusupdate_opportunity_statusUpdate an opportunity’s status.
Upsert Opportunityupsert_opportunityUpsert (create or update) an opportunity.

Payments

OperationIDDescriptionTrigger
Create Couponcreate_couponCreate a coupon.
Create Custom Provider Configcreate_custom_provider_configCreate a custom payment provider’s connect config (live/test keys).
Create Custom Provider Integrationcreate_custom_provider_integrationCreate a custom payment provider integration.
Create Order Fulfillmentcreate_order_fulfillmentCreate a fulfillment for an order.
Create White-label Integration Providercreate_whitelabel_integration_providerCreate a white-label payment integration provider.
Delete Coupondelete_couponDelete a coupon.
Delete Custom Provider Integrationdelete_custom_provider_integrationDelete a custom payment provider integration.
Disconnect Custom Provider Configdisconnect_custom_provider_configDisconnect a custom payment provider’s connect config.
Fetch Custom Provider Configfetch_custom_provider_configFetch a custom payment provider’s connect config.
Get Couponget_couponGet a coupon by id or code.
Get Orderget_order_by_idGet an order by id.
Get Subscriptionget_subscription_by_idGet a subscription by id.
Get Transactionget_transaction_by_idGet a transaction by id.
List Couponslist_couponsList coupons.
List Order Fulfillmentslist_order_fulfillmentList fulfillments for an order.
List Order Noteslist_order_notesList notes for an order.
List Orderslist_ordersList orders.
List Subscriptionslist_subscriptionsList subscriptions.
List Transactionslist_transactionsList transactions.
List White-label Integration Providerslist_whitelabel_integration_providersList white-label payment integration providers.
Record Order Paymentrecord_order_paymentRecord a manual payment against an order.
Update Couponupdate_couponUpdate a coupon.
Update Custom Provider Capabilitiesupdate_custom_provider_capabilitiesUpdate a custom payment provider marketplace app’s capabilities.

Phone system

OperationIDDescriptionTrigger
List Active Numberslist_active_numbersList active phone numbers for a location.
List Available Numberslist_available_numbersList available phone numbers to purchase for a location.
List Number Poolsget_number_pool_listList phone number pools for a location.
Purchase Phone Numberpurchase_phone_numberPurchase a phone number for a location.

Products

OperationIDDescriptionTrigger
Bulk Edit Productsbulk_edit_productsBulk edit products (upsert list of product objects).
Bulk Update Product Reviewsbulk_update_product_reviewsBulk update product reviews.
Bulk Update Productsbulk_update_productsBulk update products (price/availability/collection/currency/delete).
Create Price For Productcreate_price_for_productCreate a price for a product.
Create Productcreate_productCreate a product.
Create Product Collectioncreate_product_collectionCreate a product collection.
Delete Price For Productdelete_price_for_productDelete a price by id for a product.
Delete Productdelete_productDelete a product by id.
Delete Product Collectiondelete_product_collectionDelete a product collection.
Delete Product Reviewdelete_product_reviewDelete a product review.
Get Price For Productget_price_for_productGet a price by id for a product.
Get Productget_productGet a product by id.
Get Product Collectionget_product_collectionGet a product collection by id.
Get Product Inventoryget_product_inventoryList product inventory.
Get Product Reviews Countget_product_reviews_countGet product reviews count.
Get Product Store Statsget_product_store_statsGet product store stats.
List Prices For Productlist_prices_for_productList prices for a product.
List Product Collectionslist_product_collectionsList product collections.
List Product Reviewslist_product_reviewsList product reviews.
List Productslist_productsList products for a location (sub-account).
Update Price For Productupdate_price_for_productUpdate a price by id for a product.
Update Productupdate_productUpdate a product by id.
Update Product Collectionupdate_product_collectionUpdate a product collection.
Update Product Display Priorityupdate_product_display_priorityUpdate product display priority within a store.
Update Product Inventoryupdate_product_inventoryUpdate product inventory (list of items).
Update Product Reviewupdate_product_reviewUpdate a product review.
Update Product Store Statusupdate_product_store_statusUpdate store status for products (include/exclude).

Proposals

OperationIDDescriptionTrigger
List Documentslist_proposal_documentsList proposal/estimate documents & contracts for a location.
List Templateslist_proposal_templatesList proposal/estimate templates for a location.
Send Documentsend_proposal_documentSend an existing proposal/contract document.
Send Templatesend_proposal_templateCreate & optionally send a document from a proposal template.

SaaS

OperationIDDescriptionTrigger
Bulk Enable SaaSbulk_enable_saasBulk enable SaaS for a list of locations.
Bulk Enable SaaS (Deprecated)bulk_enable_saas_deprecated[Deprecated] Bulk enable SaaS for a list of locations.
Disable SaaS For Locationsbulk_disable_saasDisable SaaS for a list of locations.
Disable SaaS For Locations (Deprecated)bulk_disable_saas_deprecated[Deprecated] Disable SaaS for a list of locations.
Enable SaaS For Sub-Accountenable_saas_locationEnable SaaS for a sub-account (location).
Enable SaaS For Sub-Account (Deprecated)enable_saas_location_deprecated[Deprecated] Enable SaaS for a sub-account (location).
Get Agency Plansget_agency_plansGet agency (SaaS) plans for a company.
Get Agency Plans (Deprecated)get_agency_plans_deprecated[Deprecated] Get agency (SaaS) plans for a company.
Get Location Subscription Detailsget_location_subscriptionGet SaaS subscription details for a location.
Get Location Subscription Details (Deprecated)get_location_subscription_deprecated[Deprecated] Get SaaS subscription details for a location.
Get Locations By Stripe IDlocationsGet locations by stripe id with company id.
Get Locations By Stripe ID (Deprecated)locations_deprecated[Deprecated] Get locations by stripe id with company id.
Get SaaS Locationsget_saas_locationsGet SaaS locations for a company.
Get SaaS Locations (Deprecated)get_saas_locations_deprecated[Deprecated] Get SaaS locations for a company.
Get SaaS Planget_saas_planGet a SaaS plan by id.
Get SaaS Plan (Deprecated)get_saas_plan_deprecated[Deprecated] Get a SaaS plan by id.
Pause Locationpause_locationPause or unpause a location.
Pause Location (Deprecated)pause_location_deprecated[Deprecated] Pause or unpause a location.
Update Rebillingupdate_rebillingUpdate rebilling settings for a company’s locations.
Update Rebilling (Deprecated)update_rebilling_deprecated[Deprecated] Update rebilling settings for a company’s locations.
Update SaaS Subscriptiongenerate_payment_linkUpdate SaaS subscription (generate payment link).
Update SaaS Subscription (Deprecated)update_saas_subscription_deprecated[Deprecated] Update SaaS subscription.

Snapshots

OperationIDDescriptionTrigger
Create Snapshot Share Linkcreate_snapshot_share_linkCreate a share link for a snapshot.
Get Last Snapshot Pushget_latest_snapshot_pushGet the last snapshot push for a location.
Get Snapshot Push Between Datesget_snapshot_pushGet snapshot push status between two dates.
List Snapshotsget_snapshotsList snapshots for an agency (company).

Social posting

OperationIDDescriptionTrigger
Attach Facebook Pageattach_facebook_page_groupAttach a Facebook page/group to the social planner account.
Attach Instagram Accountattach_instagram_page_groupAttach an Instagram account to the social planner account.
Attach LinkedIn Pageattach_linkedin_page_profileAttach a LinkedIn page/profile to the social planner account.
Attach TikTok Profileattach_tiktok_profileAttach a TikTok profile to the social planner account.
Attach Twitter Profileattach_twitter_profileAttach a Twitter/X profile to the social planner account.
Bulk Delete Social Postsbulk_delete_social_planner_postsBulk delete social planner posts by ids.
Create Social Postcreate_social_postCreate a social planner post.
Delete CSV Postdelete_social_csv_postDelete a single post from a CSV upload.
Delete CSV Uploaddelete_social_csvDelete a CSV upload and all its posts.
Delete Social Accountdelete_social_accountDelete a connected social planner account.
Delete Social Postdelete_social_postDelete a social planner post by id.
Edit Social Postedit_social_postEdit an existing social planner post.
Finalize CSV Uploadstart_social_csv_finalizeStart finalizing (scheduling) a CSV upload’s posts.
Get CSV Postsget_social_csv_postGet the posts contained in a CSV upload.
Get Facebook Pagesget_facebook_page_groupGet Facebook pages/groups for an OAuth account.
Get Google Locationsget_google_locationsGet Google (GMB) locations for an OAuth account.
Get Instagram Accountsget_instagram_page_groupGet Instagram accounts for an OAuth account.
Get LinkedIn Pagesget_linkedin_page_profileGet LinkedIn pages/profiles for an OAuth account.
Get Social Categoryget_social_categoryGet a social planner category by id.
Get Social Media Statisticsget_social_media_statisticsGet social media posting statistics for the given profiles.
Get Social Postget_social_postGet a social planner post by id.
Get Social Tags By IDsget_social_tags_by_idsGet social planner tags by their ids.
Get TikTok Business Profilesget_tiktok_business_profileGet TikTok Business profiles for an OAuth account.
Get TikTok Profilesget_tiktok_profileGet TikTok profiles for an OAuth account.
Get Twitter Profilesget_twitter_profileGet Twitter/X profiles for an OAuth account.
List CSV Upload Statusget_social_csv_upload_statusList CSV upload statuses for a location.
List Social Accountsget_social_accountList connected social planner accounts and groups for a location.
List Social Categoriesget_social_categoriesList social planner categories for a location.
List Social Postsget_social_postsSearch/list social planner posts.
List Social Tagsget_social_tagsList social planner tags for a location.
Set Google Locationset_google_locationsAttach a Google (GMB) location to the social planner account.
Set Social Accountsset_social_accountsSet accounts for a bulk CSV import.
Start Facebook OAuthstart_facebook_oauthStart the Facebook OAuth connection flow for social planner.
Start Google OAuthstart_google_oauthStart the Google (GMB) OAuth connection flow for social planner.
Start Instagram OAuthstart_instagram_oauthStart the Instagram OAuth connection flow for social planner.
Start LinkedIn OAuthstart_linkedin_oauthStart the LinkedIn OAuth connection flow for social planner.
Start TikTok Business OAuthstart_tiktok_business_oauthStart the TikTok Business OAuth connection flow for social planner.
Start TikTok OAuthstart_tiktok_oauthStart the TikTok OAuth connection flow for social planner.
Start Twitter OAuthstart_twitter_oauthStart the Twitter/X OAuth connection flow for social planner.
Upload Social CSVupload_social_csvUpload a CSV of posts for bulk scheduling (multipart file upload).

Store

OperationIDDescriptionTrigger
Create Shipping Carriercreate_shipping_carrierCreate a shipping carrier for a location.
Create Shipping Ratecreate_shipping_rateCreate a shipping rate within a shipping zone.
Create Shipping Zonecreate_shipping_zoneCreate a shipping zone for a location.
Create/Update Store Settingscreate_store_settingCreate or update store settings for a location.
Delete Shipping Carrierdelete_shipping_carrierDelete a shipping carrier.
Delete Shipping Ratedelete_shipping_rateDelete a shipping rate.
Delete Shipping Zonedelete_shipping_zoneDelete a shipping zone.
Get Available Shipping Ratesget_available_shipping_ratesGet available shipping rates for a cart / order.
Get Shipping Carrierget_shipping_carrierGet a shipping carrier by id.
Get Shipping Rateget_shipping_rateGet a shipping rate by id.
Get Shipping Zoneget_shipping_zoneGet a shipping zone by id.
Get Store Settingsget_store_settingsGet store settings for a location.
List Shipping Carrierslist_shipping_carriersList shipping carriers for a location.
List Shipping Rateslist_shipping_ratesList shipping rates within a shipping zone.
List Shipping Zoneslist_shipping_zonesList shipping zones for a location.
Update Shipping Carrierupdate_shipping_carrierUpdate a shipping carrier.
Update Shipping Rateupdate_shipping_rateUpdate a shipping rate.
Update Shipping Zoneupdate_shipping_zoneUpdate a shipping zone.

Surveys

OperationIDDescriptionTrigger
Get Survey Submissionsget_surveys_submissionsGet survey submissions for a location.
Get Surveysget_surveysList surveys for a location.
OperationIDDescriptionTrigger
Create Linkcreate_linkCreate a trigger link within a location.
Delete Linkdelete_linkDelete a trigger link.
Get Link by IDget_link_by_idGet a trigger link by id.
List Linksget_linksList trigger links for a location.
Search Trigger Linkssearch_trigger_linksSearch trigger links for a location.
Update Linkupdate_linkUpdate a trigger link.

Users

OperationIDDescriptionTrigger
Create Usercreate_userCreate a user.
Delete Userdelete_userDelete a user.
Filter Users by Emailfilter_users_by_emailFilter users by a list of emails.
Get Userget_userGet a user by id.
List Users by Locationget_user_by_locationList users for a location (sub-account).
Search Userssearch_usersSearch users within a company.
Update Userupdate_userUpdate a user.

Voice AI

OperationIDDescriptionTrigger
Create Voice AI Actioncreate_voice_ai_actionCreate a Voice AI agent action.
Create Voice AI Agentcreate_voice_ai_agentCreate a Voice AI agent.
Delete Voice AI Actiondelete_voice_ai_actionDelete a Voice AI agent action.
Delete Voice AI Agentdelete_voice_ai_agentDelete a Voice AI agent.
Get Voice AI Actionget_voice_ai_actionGet a Voice AI agent action by id.
Get Voice AI Agentget_voice_ai_agentGet a Voice AI agent by id.
Get Voice AI Call Logget_voice_ai_call_logGet a Voice AI call log by id.
List Voice AI Agentsget_voice_ai_agentsList Voice AI agents for a location.
List Voice AI Call Logsget_voice_ai_call_logsList Voice AI call logs.
Patch Voice AI Agentpatch_voice_ai_agentPatch (update) a Voice AI agent.
Update Voice AI Actionupdate_voice_ai_actionUpdate a Voice AI agent action.

Workflows

OperationIDDescriptionTrigger
List Workflowsget_workflowList workflows for a location (sub-account).

Other

OperationIDDescriptionTrigger
On Any Webhook Eventon_webhookCatch-all: fire on ANY HighLevel webhook POSTed to this URL (no event filter). Useful with a marketplace-app single-URL subscription or when you want one endpoint for all of a workflow’s events.Yes
On App Installedon_app_installYes
On App Uninstalledon_app_uninstallYes
On App Updatedon_app_updateYes
On Appointment Createdon_appointment_createYes
On Appointment Deletedon_appointment_deleteYes
On Appointment Updatedon_appointment_updateYes
On Association Createdon_association_createYes
On Association Deletedon_association_deleteYes
On Association Updatedon_association_updateYes
On Campaign Status Changedon_campaign_status_updateYes
On Contact Createdon_contact_createYes
On Contact Deletedon_contact_deleteYes
On Contact DND Updatedon_contact_dnd_updateYes
On Contact Tags Updatedon_contact_tag_updateYes
On Contact Updatedon_contact_updateYes
On Conversation Unread Changeon_conversation_unreadYes
On Conversation Updatedon_conversation_updateYes
On Email Stats (delivered/opened/clicked)on_email_statsYes
On External Auth Connectedon_external_auth_connectedYes
On Inbound Messageon_inbound_messageYes
On Invoice Createdon_invoice_createYes
On Invoice Deletedon_invoice_deleteYes
On Invoice Paidon_invoice_paidYes
On Invoice Partially Paidon_invoice_partially_paidYes
On Invoice Senton_invoice_sentYes
On Invoice Updatedon_invoice_updateYes
On Invoice Voidedon_invoice_voidYes
On Knowledge Base Createdon_knowledge_base_createYes
On Knowledge Base Deletedon_knowledge_base_deleteYes
On Knowledge Base FAQ Changedon_knowledge_base_faq_changeYes
On Knowledge Base File Changedon_knowledge_base_file_changeYes
On Knowledge Base Table Changedon_knowledge_base_table_file_changeYes
On Knowledge Base Text Changedon_knowledge_base_rich_text_changeYes
On Knowledge Base Updatedon_knowledge_base_updateYes
On Knowledge Base URL Trainedon_knowledge_base_trained_url_changeYes
On Note Createdon_note_createYes
On Note Deletedon_note_deleteYes
On Note Updatedon_note_updateYes
On Object Schema Createdon_object_schema_createYes
On Object Schema Updatedon_object_schema_updateYes
On Opportunity Assignee Changedon_opportunity_assigned_to_updateYes
On Opportunity Createdon_opportunity_createYes
On Opportunity Deletedon_opportunity_deleteYes
On Opportunity Stage Changedon_opportunity_stage_updateYes
On Opportunity Status Changedon_opportunity_status_updateYes
On Opportunity Updatedon_opportunity_updateYes
On Opportunity Value Changedon_opportunity_monetary_value_updateYes
On Order Createdon_order_createYes
On Order Status Changedon_order_status_updateYes
On Outbound Messageon_outbound_messageYes
On Price Createdon_price_createYes
On Price Deletedon_price_deleteYes
On Price Updatedon_price_updateYes
On Product Createdon_product_createYes
On Product Deletedon_product_deleteYes
On Product Updatedon_product_updateYes
On Provider Outbound Messageon_provider_outbound_messageYes
On Record Createdon_record_createYes
On Record Deletedon_record_deleteYes
On Record Updatedon_record_updateYes
On Relation Createdon_relation_createYes
On Relation Deletedon_relation_deleteYes
On SaaS Plan Changedon_plan_changeYes
On SaaS Plan Createdon_saas_plan_createYes
On Sub-Account Createdon_location_createYes
On Sub-Account Updatedon_location_updateYes
On Task Completedon_task_completeYes
On Task Createdon_task_createYes
On Task Deletedon_task_deleteYes
On User Createdon_user_createYes
On User Deletedon_user_deleteYes
On User Updatedon_user_updateYes
On Voice AI Call Endedon_voice_ai_call_endYes