> ## Documentation Index > Fetch the complete documentation index at: https://docs.noclick.com/llms.txt > Use this file to discover all available pages before exploring further. # GoHighLevel > Connect GoHighLevel to your workflows: 647 operations across 41 categories. 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](/agents/tools). ## Credentials Connect GoHighLevel under **Credentials** in the node settings. See [Connecting credentials](/credentials/connecting) 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](https://help.leadconnectorhq.com/support/solutions/articles/155000002774-private-integrations-everything-you-need-to-know). ## Operations ### Ad manager | Operation | ID | Description | Trigger | | ------------------------------------- | ------------------------------------- | --------------------------------- | ------- | | **Add custom audience member** | `fb_add_custom_audience_member` | Add custom audience member | | | **Batch update audience members** | `fb_batch_update_audience_members` | Batch update audience members | | | **Create conversation form** | `fb_create_conversation_form` | Create conversation form | | | **Create Facebook integration** | `fb_create_integration` | Create Facebook integration | | | **Create Google integration** | `google_create_integration` | Create Google integration | | | **Create lead form** | `li_create_lead_form` | Create lead form | | | **Create LinkedIn integration** | `li_create_integration` | Create LinkedIn integration | | | **Create offline user list job** | `google_create_offline_user_list_job` | Create offline user list job | | | **Create page lead form** | `fb_create_page_lead_form` | Create page lead form | | | **Delete ad** | `fb_delete_ad` | Delete ad | | | **Delete ad account** | `fb_delete_ad_account` | Delete ad account | | | **Delete ad account** | `google_delete_ad_account` | Delete ad account | | | **Delete ad account** | `li_delete_ad_account` | Delete ad account | | | **Delete ad set** | `fb_delete_adset` | Delete ad set | | | **Delete campaign** | `fb_delete_campaign` | Delete campaign | | | **Delete conversion** | `google_delete_conversion` | Delete conversion | | | **Delete custom audience** | `fb_delete_custom_audience` | Delete custom audience | | | **Delete Facebook integration** | `fb_delete_integration` | Delete Facebook integration | | | **Delete page connection** | `fb_delete_page` | Delete page connection | | | **Delete segment** | `google_delete_segment` | Delete segment | | | **Duplicate ad** | `fb_duplicate_ad` | Duplicate ad | | | **Duplicate ad set** | `fb_duplicate_adset` | Duplicate ad set | | | **Duplicate campaign** | `fb_duplicate_campaign` | Duplicate campaign | | | **Get ad account details** | `fb_get_ad_account` | Get ad account details | | | **Get ad account details** | `google_get_ad_account_details` | Get ad account details | | | **Get ad account details** | `li_get_ad_account_details` | Get ad account details | | | **Get ad accounts** | `fb_get_ad_accounts` | Get ad accounts | | | **Get ad analytics** | `li_get_ad_analytics` | Get ad analytics | | | **Get ad campaign group** | `li_get_campaign_group` | Get ad campaign group | | | **Get assets** | `google_get_assets` | Get assets | | | **Get audience by ID** | `google_get_audience_by_id` | Get audience by ID | | | **Get audiences** | `google_get_audiences` | Get audiences | | | **Get campaign group reporting** | `li_get_campaign_group_reporting` | Get campaign group reporting | | | **Get campaign reporting** | `fb_get_campaign_reporting` | Get campaign reporting | | | **Get campaign reporting** | `google_get_campaign_reporting` | Get campaign reporting | | | **Get campaign with linked entities** | `fb_get_campaign` | Get campaign with linked entities | | | **Get conversation forms** | `fb_get_conversation_forms` | Get conversation forms | | | **Get conversion by ID** | `google_get_conversion_by_id` | Get conversion by ID | | | **Get conversion goals** | `google_get_conversion_goals` | Get conversion goals | | | **Get conversion pixels** | `fb_get_pixels` | Get conversion pixels | | | **Get conversions** | `google_get_conversions` | Get conversions | | | **Get current Facebook user** | `fb_get_current_user` | Get current Facebook user | | | **Get current Google user** | `google_get_current_user` | Get current Google user | | | **Get current LinkedIn user** | `li_get_current_user` | Get current LinkedIn user | | | **Get custom audience by ID** | `fb_get_custom_audience_by_id` | Get custom audience by ID | | | **Get custom audiences** | `fb_get_custom_audiences` | Get custom audiences | | | **Get entities** | `fb_get_entity` | Get entities | | | **Get entities** | `google_get_entity` | Get entities | | | **Get Facebook integration** | `fb_get_integration` | Get Facebook integration | | | **Get Facebook pages** | `fb_get_pages` | Get Facebook pages | | | **Get Google ad accounts** | `google_get_ad_accounts` | Get Google ad accounts | | | **Get Google campaign by ID** | `google_get_campaign_by_id` | Get Google campaign by ID | | | **Get Google integration** | `google_get_integration` | Get Google integration | | | **Get Instagram accounts for page** | `fb_get_instagram_accounts` | Get Instagram accounts for page | | | **Get keyword ideas** | `google_get_keyword_ideas` | Get keyword ideas | | | **Get lead form by ID** | `fb_get_lead_form` | Get lead form by ID | | | **Get lead forms** | `li_get_lead_forms` | Get lead forms | | | **Get LinkedIn ad accounts** | `li_get_ad_accounts` | Get LinkedIn ad accounts | | | **Get LinkedIn integration** | `li_get_integration` | Get LinkedIn integration | | | **Get page lead forms** | `fb_get_page_lead_forms` | Get page lead forms | | | **Get reporting data** | `fb_get_reporting` | Get reporting data | | | **Get reporting data** | `google_get_reporting` | Get reporting data | | | **Get reporting list** | `fb_get_reporting_list` | Get reporting list | | | **Get reporting list** | `google_get_reporting_list` | Get reporting list | | | **Get reporting list** | `li_get_reporting_list` | Get reporting list | | | **Get segment by ID** | `google_get_segment_by_id` | Get segment by ID | | | **Get segments** | `google_get_segments` | Get segments | | | **Get target interests** | `google_get_target_interests` | Get target interests | | | **Pause ad** | `fb_pause_ad` | Pause ad | | | **Pause ad set** | `fb_pause_adset` | Pause ad set | | | **Pause campaign** | `fb_pause_campaign` | Pause campaign | | | **Publish ad** | `google_publish_ad` | Publish ad | | | **Publish ad campaign group** | `li_publish_campaign_group` | Publish ad campaign group | | | **Publish campaign** | `fb_publish_campaign` | Publish campaign | | | **Remove custom audience member** | `fb_remove_custom_audience_member` | Remove custom audience member | | | **Resume ad** | `fb_resume_ad` | Resume ad | | | **Resume ad set** | `fb_resume_adset` | Resume ad set | | | **Resume campaign** | `fb_resume_campaign` | Resume campaign | | | **Search targeting options** | `fb_search_targeting` | Search targeting options | | | **Search targeting options** | `google_search_targeting` | Search targeting options | | | **Search targeting options** | `li_search_targeting` | Search targeting options | | | **Set default page** | `fb_set_default_page` | Set default page | | | **Update ad status** | `li_update_ad_status` | Update ad status | | | **Update custom audience** | `fb_update_custom_audience` | Update custom audience | | | **Upsert ad** | `fb_upsert_ad` | Upsert ad | | | **Upsert ad campaign group** | `li_upsert_campaign_group` | Upsert ad campaign group | | | **Upsert adset** | `fb_upsert_adset` | Upsert adset | | | **Upsert assets** | `google_upsert_assets` | Upsert assets | | | **Upsert audience** | `google_upsert_audience` | Upsert audience | | | **Upsert campaign** | `fb_upsert_campaign` | Upsert campaign | | | **Upsert conversion** | `google_upsert_conversion` | Upsert conversion | | | **Upsert conversion pixel** | `fb_upsert_pixel` | Upsert conversion pixel | | | **Upsert Google campaign** | `google_upsert_campaign` | Upsert Google campaign | | | **Upsert segment** | `google_upsert_segment` | Upsert segment | | ### Affiliate manager | Operation | ID | Description | Trigger | | -------------------- | ------------------ | -------------------------------------------------------- | ------- | | **Get Affiliate** | `get_affiliate` | Get an affiliate by id. | | | **List Affiliates** | `list_affiliates` | List affiliates for a location (sub-account). | | | **List Commissions** | `list_commissions` | List affiliate commissions for a location (sub-account). | | | **List Payouts** | `list_payouts` | List affiliate payouts for a location (sub-account). | | ### Agent studio | Operation | ID | Description | Trigger | | ------------------------------ | ---------------------------- | ---------------------------------------------------- | ------- | | **Create Agent** | `create_studio_agent` | Create an agent for a location. | | | **Delete Agent** | `delete_studio_agent` | Delete an agent. | | | **Execute Agent** | `execute_agent` | Execute an agent with a message. | | | **Execute Agent (Deprecated)** | `execute_agent_deprecated` | Execute an agent (deprecated public-api endpoint). | | | **Get Agent** | `get_agent_by_id` | Get an agent by id. | | | **Get Agent (Deprecated)** | `get_agent_by_id_deprecated` | Get an agent by id (deprecated public-api endpoint). | | | **List Agents** | `get_agents` | List agents for a location. | | | **List Agents (Deprecated)** | `get_agents_deprecated` | List agents (deprecated public-api endpoint). | | | **Promote to Production** | `promote_and_publish_agent` | Promote an agent version to production and publish. | | | **Update Agent** | `update_agent_version` | Update an agent version. | | | **Update Agent Metadata** | `update_agent_metadata` | Update an agent's metadata. | | ### Associations | Operation | ID | Description | Trigger | | ---------------------------------- | --------------------------------- | -------------------------------------------------- | ------- | | **Create Association** | `create_association` | Create an association. | | | **Create Relation** | `create_relation` | Create a relation between two associated records. | | | **Delete Association** | `delete_association` | Delete an association. | | | **Delete Relation** | `delete_relation` | Delete a relation. | | | **Find Associations** | `find_associations` | Get all associations for a sub-account / location. | | | **Get Association By ID** | `get_association_by_id` | Get an association by id. | | | **Get Association By Key Name** | `get_association_key_by_key_name` | Get an association by its unique key name. | | | **Get Association By Object Keys** | `get_association_by_object_keys` | Get an association by object keys. | | | **Get Relations By Record** | `get_relations_by_record_id` | Get all relations by record id. | | | **Update Association** | `update_association` | Update an association by id. | | ### Blogs | Operation | ID | Description | Trigger | | ------------------------ | ------------------------------------- | ----------------------------------------------------------------- | ------- | | **Check Blog URL Slug** | `check_url_slug_exists` | Check whether a blog post url slug already exists for a location. | | | **Create Blog Post** | `create_blog_post` | Create a blog post. | | | **List Blog Authors** | `get_all_blog_authors_by_location` | List blog authors for a location. | | | **List Blog Categories** | `get_all_blog_categories_by_location` | List blog categories for a location. | | | **List Blog Posts** | `get_blog_posts_by_blog` | Get blog posts by blog id. | | | **List Blogs** | `get_blogs_by_location` | List blogs (sites) for a location. | | | **Update Blog Post** | `update_blog_post` | Update a blog post. | | ### Brand boards | Operation | ID | Description | Trigger | | ---------------------- | ------------------------------ | ----------------------------------------------- | ------- | | **Create Brand Board** | `create_brand_board` | Create a new brand board. | | | **Delete Brand Board** | `delete_brand_board` | Delete a brand board. | | | **Get Brand Board** | `get_brand_board_by_id` | Get a brand board by id. | | | **List Brand Boards** | `get_brand_boards_by_location` | List brand boards for a location (sub-account). | | | **Update Brand Board** | `update_brand_board` | Update a brand board. | | ### Businesses | Operation | ID | Description | Trigger | | ------------------- | ---------------------------- | --------------------------------------------- | ------- | | **Create Business** | `create_business` | Create a business within a location. | | | **Delete Business** | `delete_business` | Delete a business. | | | **Get Business** | `get_business` | Get a business by id. | | | **List Businesses** | `get_businesses_by_location` | List businesses for a location (sub-account). | | | **Update Business** | `update_business` | Update a business. | | ### Calendars | Operation | ID | Description | Trigger | | --------------------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | | **Add Calendar To Schedule** | `add_calendar_to_schedule` | Apply a user availability schedule to a calendar. | | | **Create Appointment** | `create_appointment` | Create an appointment on a calendar. | | | **Create Appointment Note** | `create_appointment_note` | Create a note on an appointment. | | | **Create Availability Schedule** | `create_availability_schedule` | Create a user availability schedule. | | | **Create Block Slot** | `create_block_slot` | Create a block slot. | | | **Create Calendar** | `create_calendar` | Create a calendar. Complex nested fields (notifications, teamMembers, openHours, availabilities, locationConfigurations, recurring) accept raw JSON strings. | | | **Create Calendar Group** | `create_calendar_group` | Create a calendar group. | | | **Create Calendar Notification** | `create_calendar_notification` | Create calendar notifications. The API accepts a JSON array of notification objects. | | | **Create Calendar Resource** | `create_calendar_resource` | Create a calendar resource. | | | **Delete Appointment Note** | `delete_appointment_note` | Delete a note on an appointment. | | | **Delete Availability Schedule** | `delete_availability_schedule` | Delete a user availability schedule. | | | **Delete Calendar** | `delete_calendar` | Delete a calendar. | | | **Delete Calendar Event** | `delete_calendar_event` | Delete a calendar event (appointment or block slot). | | | **Delete Calendar Group** | `delete_calendar_group` | Delete a calendar group. | | | **Delete Calendar Notification** | `delete_calendar_notification` | Delete a calendar notification. | | | **Delete Calendar Resource** | `delete_calendar_resource` | Delete a calendar resource. | | | **Disable/Enable Calendar Group** | `disable_calendar_group` | Enable or disable a calendar group. | | | **Get Appointment** | `get_appointment` | Get an appointment by event id. | | | **Get Availability Schedule** | `get_availability_schedule` | Get a user availability schedule by id. | | | **Get Blocked Slots** | `get_blocked_slots` | Get blocked slots in a time range. | | | **Get Calendar** | `get_calendar` | Get a calendar by id. | | | **Get Calendar Events** | `get_calendar_events` | Get calendar events in a time range. | | | **Get Calendar Notification** | `find_calendar_notification` | Get a single calendar notification. | | | **Get Calendar Resource** | `get_calendar_resource` | Get a calendar resource by type and id. | | | **Get Free Slots** | `get_free_slots` | Get free/available slots for a calendar. | | | **List Appointment Notes** | `get_appointment_notes` | List notes on an appointment. | | | **List Availability Schedules** | `get_availability_schedules` | List user availability schedules. | | | **List Calendar Groups** | `get_calendar_groups` | List calendar groups for a location. | | | **List Calendar Notifications** | `get_calendar_notifications` | List notifications configured on a calendar. | | | **List Calendar Resources** | `list_calendar_resources` | List calendar resources of a type. | | | **List Calendars** | `get_calendars` | List calendars for a location. | | | **Remove Calendar From Schedule** | `remove_calendar_from_schedule` | Remove a user availability schedule from a calendar. | | | **Update Appointment** | `edit_appointment` | Update an existing appointment. | | | **Update Appointment Note** | `update_appointment_note` | Update a note on an appointment. | | | **Update Availability Schedule** | `update_availability_schedule` | Update a user availability schedule. | | | **Update Block Slot** | `edit_block_slot` | Update a block slot. | | | **Update Calendar** | `update_calendar` | Update a calendar. Complex nested fields accept raw JSON strings. | | | **Update Calendar Group** | `update_calendar_group` | Update a calendar group. | | | **Update Calendar Notification** | `update_calendar_notification` | Update a calendar notification. | | | **Update Calendar Resource** | `update_calendar_resource` | Update a calendar resource. | | | **Validate Group Slug** | `validate_calendar_group_slug` | Validate a calendar group slug is available. | | ### Campaigns | Operation | ID | Description | Trigger | | ----------------- | --------------- | -------------------------------------------- | ------- | | **Get Campaigns** | `get_campaigns` | List campaigns for a location (sub-account). | | ### Companies | Operation | ID | Description | Trigger | | --------------- | ------------- | ----------------------------- | ------- | | **Get Company** | `get_company` | Get a company (agency) by id. | | ### Contacts | Operation | ID | Description | Trigger | | ------------------------------------------ | ------------------------------------ | ----------------------------------------------------- | ------- | | **Add Contact Followers** | `add_contact_followers` | Add followers to a contact. | | | **Add Contact Tags** | `add_contact_tags` | Add tags to a contact. | | | **Add Contact To Campaign** | `add_contact_to_campaign` | Add a contact to a campaign. | | | **Add Contact To Workflow** | `add_contact_to_workflow` | Add a contact to a workflow. | | | **Bulk Add/Remove Contacts From Business** | `bulk_update_contacts_business` | Add or remove multiple contacts from a business. | | | **Bulk Update Contacts Tags** | `bulk_update_contacts_tags` | Bulk add or remove tags across many contacts. | | | **Create Contact** | `create_contact` | Create a contact. | | | **Create Contact Note** | `create_contact_note` | Create a note for a contact. | | | **Create Contact Task** | `create_contact_task` | Create a task for a contact. | | | **Delete Contact** | `delete_contact` | Delete a contact. | | | **Delete Contact Note** | `delete_contact_note` | Delete a contact's note. | | | **Delete Contact Task** | `delete_contact_task` | Delete a contact's task. | | | **Get Appointments For Contact** | `get_appointments_for_contact` | Get appointments for a contact. | | | **Get Contact** | `get_contact` | Get a contact by id. | | | **Get Contact Note** | `get_contact_note` | Get a single note for a contact. | | | **Get Contact Notes** | `get_contact_notes` | Get all notes for a contact. | | | **Get Contact Task** | `get_contact_task` | Get a single task for a contact. | | | **Get Contact Tasks** | `get_contact_tasks` | Get all tasks for a contact. | | | **Get Contacts By Business** | `get_contacts_by_business_id` | Get contacts belonging to a business. | | | **Get Duplicate Contact** | `get_duplicate_contact` | Find a duplicate contact by phone number or email. | | | **List Contacts** | `get_contacts` | List contacts for a location. | | | **Remove Contact Followers** | `remove_contact_followers` | Remove followers from a contact. | | | **Remove Contact From Campaign** | `remove_contact_from_campaign` | Remove a contact from a campaign. | | | **Remove Contact From Every Campaign** | `remove_contact_from_every_campaign` | Remove a contact from every campaign. | | | **Remove Contact From Workflow** | `remove_contact_from_workflow` | Remove a contact from a workflow. | | | **Remove Contact Tags** | `remove_contact_tags` | Remove tags from a contact. | | | **Search Contacts (Advanced)** | `search_contacts_advanced` | Advanced search for contacts (POST /contacts/search). | | | **Update Contact** | `update_contact` | Update a contact. | | | **Update Contact Note** | `update_contact_note` | Update a contact's note. | | | **Update Contact Task** | `update_contact_task` | Update a contact's task. | | | **Update Contact Task Completed** | `update_contact_task_completed` | Set the completed flag on a contact's task. | | | **Upsert Contact** | `upsert_contact` | Create or update a contact (upsert). | | ### Conversation AI | Operation | ID | Description | Trigger | | ---------------------------------- | -------------------------------- | ---------------------------------------------- | ------- | | **Create Agent** | `create_conversation_ai_agent` | Create a Conversation AI agent (employee). | | | **Create Agent Action** | `create_agent_action` | Attach an action to a Conversation AI agent. | | | **Delete Agent** | `delete_conversation_ai_agent` | Delete a Conversation AI agent. | | | **Delete Agent Action** | `delete_agent_action` | Remove an action from an agent. | | | **Get Agent** | `get_conversation_ai_agent` | Get a Conversation AI agent by id. | | | **Get Agent Action** | `get_agent_action_by_id` | Get a single agent action by id. | | | **Get Generation Details** | `get_generation_details` | Get generation details for a message. | | | **List Agent Actions** | `list_agent_actions` | List the actions attached to an agent. | | | **Search Agents** | `search_conversation_ai_agents` | Search Conversation AI agents. | | | **Update Agent** | `update_conversation_ai_agent` | Update a Conversation AI agent. | | | **Update Agent Action** | `update_agent_action` | Update an agent action. | | | **Update Agent Followup Settings** | `update_agent_followup_settings` | Update an agent's advanced follow-up settings. | | ### Conversations | Operation | ID | Description | Trigger | | ------------------------------------- | ----------------------------------- | ----------------------------------------------------------------- | ------- | | **Add An Inbound Message** | `add_an_inbound_message` | Add an inbound message to a conversation. | | | **Add An Outbound Message** | `add_an_outbound_message` | Add an external outbound call message. | | | **Add Message Attachments** | `add_message_attachments` | Add attachments to an existing message. | | | **Cancel Scheduled Email Message** | `cancel_scheduled_email_message` | Cancel a scheduled email message. | | | **Cancel Scheduled Message** | `cancel_scheduled_message` | Cancel a scheduled message. | | | **Complete File Upload** | `complete_file_upload` | Complete a file upload. | | | **Create Conversation** | `create_conversation` | Create a conversation. | | | **Create Custom Subtype** | `create_custom_subtype` | Create a custom message subtype. | | | **Delete Conversation** | `delete_conversation` | Delete a conversation. | | | **Download Message Transcription** | `download_message_transcription` | Download a call transcription by message id. | | | **Export Messages By Location** | `export_messages_by_location` | Export messages for a location. | | | **Get All Custom Subtypes** | `get_all_custom_subtypes` | List all custom message subtypes for a location. | | | **Get Contact Unsubscription Status** | `get_contact_unsubscription_status` | Get a contact's unsubscription status. | | | **Get Conversation** | `get_conversation` | Get a conversation by id. | | | **Get Email By ID** | `get_email_by_id` | Get an email message by id. | | | **Get Message** | `get_message` | Get a message by id. | | | **Get Message Recording** | `get_message_recording` | Get a call recording by message id. | | | **Get Message Transcription** | `get_message_transcription` | Get a call transcription by message id. | | | **Get Messages** | `get_messages` | Get messages for a conversation. | | | **Initiate File Upload** | `initiate_file_upload` | Initiate a file upload to GCS. | | | **Live Chat Agent Typing** | `live_chat_agent_typing` | Send a live-chat agent typing indicator. | | | **Search Conversations** | `search_conversation` | Search conversations within a location. | | | **Send A New Message** | `send_a_new_message` | Send a new message. | | | **Send Review Reply** | `send_review_reply` | Send a review reply to Google My Business. | | | **Update Conversation** | `update_conversation` | Update a conversation. | | | **Update Custom Subtype** | `update_custom_subtype` | Update a custom message subtype. | | | **Update Message Status** | `update_message_status` | Update a message's delivery status. | | | **Upload File Attachments** | `upload_file_attachments` | Upload file attachments (from attachment URLs) to a conversation. | | | **User Subscription Change** | `user_subscription_change` | Change a user's subscription (subscribe/unsubscribe). | | ### Courses | Operation | ID | Description | Trigger | | ------------------ | ---------------- | ------------------------------------------------------------------- | ------- | | **Import Courses** | `import_courses` | Import courses (products) into a location via the courses exporter. | | ### Custom fields | Operation | ID | Description | Trigger | | ----------------------------------- | --------------------------------- | ------------------------------------- | ------- | | **Create Custom Field** | `create_custom_field_v2` | Create a custom field. | | | **Create Custom Field Folder** | `create_custom_field_folder` | Create a custom field folder. | | | **Delete Custom Field** | `delete_custom_field_v2` | Delete a custom field by id. | | | **Delete Custom Field Folder** | `delete_custom_field_folder` | Delete a custom field folder. | | | **Get Custom Field / Folder By ID** | `get_custom_field_by_id` | Get a custom field or folder by id. | | | **Get Custom Fields By Object Key** | `get_custom_fields_by_object_key` | List custom fields for an object key. | | | **Update Custom Field** | `update_custom_field_v2` | Update a custom field by id. | | | **Update Custom Field Folder** | `update_custom_field_folder` | Update a custom field folder name. | | ### Custom menus | Operation | ID | Description | Trigger | | --------------------------- | ----------------------- | -------------------------------------- | ------- | | **Create Custom Menu Link** | `create_custom_menu` | Create a new custom menu link. | | | **Delete Custom Menu Link** | `delete_custom_menu` | Delete a custom menu link. | | | **Get Custom Menu Link** | `get_custom_menu_by_id` | Fetch a single custom menu link by id. | | | **List Custom Menu Links** | `get_custom_menus` | List custom menu links. | | | **Update Custom Menu Link** | `update_custom_menu` | Update an existing custom menu link. | | ### Custom objects | Operation | ID | Description | Trigger | | ------------------------ | ----------------------------- | ------------------------------------ | ------- | | **Create Custom Object** | `create_custom_object_schema` | Create a custom object schema. | | | **Create Record** | `create_object_record` | Create an object record. | | | **Delete Record** | `delete_object_record` | Delete an object record. | | | **Get Object Schema** | `get_object_schema_by_key` | Get an object schema by key / id. | | | **Get Record** | `get_object_record_by_id` | Get an object record by id. | | | **List Objects** | `get_object_by_location_id` | Get all objects for a location. | | | **Search Records** | `search_object_records` | Search object records. | | | **Update Object Schema** | `update_custom_object` | Update an object schema by key / id. | | | **Update Record** | `update_object_record` | Update an object record. | | ### Email builder | Operation | ID | Description | Trigger | | ------------------------- | ----------------------- | --------------------------------------------- | ------- | | **Create Email Template** | `create_email_template` | Create a new email template. | | | **Delete Email Template** | `delete_email_template` | Delete an email template. | | | **Fetch Email Templates** | `fetch_email_templates` | Fetch email templates for a location. | | | **Get Email Campaigns** | `fetch_email_campaigns` | Get email campaigns/schedules for a location. | | | **Update Email Template** | `update_email_template` | Update an email template (save builder data). | | ### Email verification | Operation | ID | Description | Trigger | | ---------------- | -------------- | ------------------------------------------------------------ | ------- | | **Verify Email** | `verify_email` | Verify an email address or a contact's email deliverability. | | ### Forms | Operation | ID | Description | Trigger | | --------------------------------- | ------------------------- | ------------------------------------------- | ------- | | **Get Form Submissions** | `get_forms_submissions` | Get form submissions for a location. | | | **Get Forms** | `get_forms` | Get forms for a location. | | | **Upload Files to Custom Fields** | `upload_to_custom_fields` | Upload files to custom fields on a contact. | | ### Funnels | Operation | ID | Description | Trigger | | ---------------------- | ----------------------------- | --------------------------------------------- | ------- | | **Count Funnel Pages** | `get_funnel_pages_count` | Fetch the count of funnel pages for a funnel. | | | **Create Redirect** | `create_funnel_redirect` | Create a funnel redirect. | | | **Delete Redirect** | `delete_funnel_redirect` | Delete a funnel redirect by id. | | | **List Funnel Pages** | `get_funnel_pages` | Fetch the list of funnel pages for a funnel. | | | **List Funnels** | `get_funnels` | Fetch the list of funnels. | | | **List Redirects** | `fetch_funnel_redirects_list` | Fetch the list of funnel redirects. | | | **Update Redirect** | `update_funnel_redirect` | Update a funnel redirect by id. | | ### Invoices | Operation | ID | Description | Trigger | | ------------------------------------------ | ------------------------------------------------- | ------------------------------------------------------------- | ------- | | **Auto Payment Invoice Schedule** | `auto_payment_invoice_schedule` | Manage auto-payment for an invoice schedule. | | | **Cancel Invoice Schedule** | `cancel_invoice_schedule` | Cancel an invoice schedule. | | | **Create Estimate** | `create_new_estimate` | Create a new estimate. | | | **Create Estimate Template** | `create_estimate_template` | Create an estimate template. | | | **Create Invoice** | `create_invoice` | Create an invoice. | | | **Create Invoice From Estimate** | `create_invoice_from_estimate` | Create an invoice from an estimate. | | | **Create Invoice Schedule** | `create_invoice_schedule` | Create an invoice schedule (recurring invoice). | | | **Create Invoice Template** | `create_invoice_template` | Create an invoice template. | | | **Delete Estimate** | `delete_estimate` | Delete an estimate. | | | **Delete Estimate Template** | `delete_estimate_template` | Delete an estimate template. | | | **Delete Invoice** | `delete_invoice` | Delete an invoice. | | | **Delete Invoice Schedule** | `delete_invoice_schedule` | Delete an invoice schedule. | | | **Delete Invoice Template** | `delete_invoice_template` | Delete an invoice template. | | | **Generate Estimate Number** | `generate_estimate_number` | Generate the next estimate number. | | | **Generate Invoice Number** | `generate_invoice_number` | Generate the next invoice number. | | | **Get Invoice** | `get_invoice` | Get an invoice by id. | | | **Get Invoice Schedule** | `get_invoice_schedule` | Get an invoice schedule by id. | | | **Get Invoice Settings** | `get_invoice_settings` | Get invoice settings for a location. | | | **Get Invoice Template** | `get_invoice_template` | Get an invoice template by id. | | | **List Estimate Templates** | `list_estimate_templates` | List estimate templates. | | | **List Estimates** | `list_estimates` | List estimates. | | | **List Invoice Schedules** | `list_invoice_schedules` | List invoice schedules. | | | **List Invoice Templates** | `list_invoice_templates` | List invoice templates. | | | **List Invoices** | `list_invoices` | List invoices. | | | **Preview Estimate Template** | `preview_estimate_template` | Preview an estimate template. | | | **Record Invoice Payment** | `record_invoice` | Record a manual payment against an invoice. | | | **Schedule Invoice Schedule** | `schedule_invoice_schedule` | Schedule an invoice schedule. | | | **Send Estimate** | `send_estimate` | Send an estimate. | | | **Send Invoice** | `send_invoice` | Send an invoice. | | | **Text2Pay Invoice** | `text2pay_invoice` | Create & send a text2pay invoice. | | | **Update And Schedule Invoice Schedule** | `update_and_schedule_invoice_schedule` | Update and schedule an invoice schedule. | | | **Update Estimate** | `update_estimate` | Update an estimate. | | | **Update Estimate Last Visited At** | `update_estimate_last_visited_at` | Update the last-visited-at stat for an estimate. | | | **Update Estimate Template** | `update_estimate_template` | Update an estimate template. | | | **Update Invoice** | `update_invoice` | Update an invoice. | | | **Update Invoice Last Visited At** | `update_invoice_last_visited_at` | Update the last-visited-at stat for an invoice. | | | **Update Invoice Late Fees Config** | `update_invoice_late_fees_configuration` | Update late-fees configuration for an invoice. | | | **Update Invoice Schedule** | `update_invoice_schedule` | Update an invoice schedule. | | | **Update Invoice Template** | `update_invoice_template` | Update an invoice template. | | | **Update Template Late Fees Config** | `update_invoice_template_late_fees_configuration` | Update late-fees configuration for an invoice template. | | | **Update Template Payment Methods Config** | `update_invoice_payment_methods_configuration` | Update payment-methods configuration for an invoice template. | | | **Void Invoice** | `void_invoice` | Void an invoice. | | ### Knowledge base | Operation | ID | Description | Trigger | | ------------------------------- | --------------------------------------------- | ------------------------------------------------------------------ | ------- | | **Create Knowledge Base** | `create_knowledge_base` | Create a new knowledge base (max 15 knowledge bases per location). | | | **Create Knowledge Base FAQ** | `create_knowledge_base_faq` | Create a new FAQ inside knowledge base. | | | **Delete Knowledge Base** | `delete_knowledge_base` | Delete a knowledge base. | | | **Delete Knowledge Base FAQ** | `delete_knowledge_base_faq` | Delete an existing knowledge base FAQ. | | | **Delete Trained Website URLs** | `delete_trained_urls_for_knowledge_base` | Delete trained pages. | | | **Discover Website Pages** | `discover_website` | Start crawling and discover pages for training. | | | **Get Crawling Status** | `get_crawling_status_for_latest_operation` | Get crawling status for the latest operation. | | | **Get Knowledge Base** | `get_knowledge_base_by_id` | Get knowledge base by ID. | | | **List Knowledge Base FAQs** | `list_knowledge_base_faqs` | Get all FAQs by knowledge base with pagination support. | | | **List Knowledge Bases** | `list_all_knowledge_bases_paginated` | Get all knowledge bases for a location by location Id (paginated). | | | **List Trained Website URLs** | `get_all_website_urls_data_by_knowledge_base` | Get all trained page links by knowledge base. | | | **Train Discovered URLs** | `train_discovered_urls` | Train discovered website pages and ingest into the knowledge base. | | | **Update Knowledge Base** | `update_knowledge_base` | Update a knowledge base. | | | **Update Knowledge Base FAQ** | `update_knowledge_base_faq` | Update an existing knowledge base FAQ. | | ### Locations | Operation | ID | Description | Trigger | | ----------------------------- | --------------------------- | ------------------------------------------------------------ | ------- | | **Create Custom Field** | `create_custom_field` | Create a custom field in a sub-account (location). | | | **Create Custom Value** | `create_custom_value` | Create a custom value in a sub-account (location). | | | **Create Location Tag** | `create_location_tag` | Create a tag in a sub-account (location). | | | **Create Recurring Task** | `create_recurring_task` | Create a recurring task within a sub-account (location). | | | **Create Sub-Account** | `create_location` | Create a sub-account (location). | | | **Delete Custom Field** | `delete_custom_field` | Delete a custom field. | | | **Delete Custom Value** | `delete_custom_value` | Delete a custom value. | | | **Delete Location Tag** | `delete_location_tag` | Delete a location tag. | | | **Delete Recurring Task** | `delete_recurring_task` | Delete a recurring task. | | | **Delete Sub-Account** | `delete_location` | Delete a sub-account (location). | | | **Delete Template** | `delete_location_template` | Delete an email/SMS template. | | | **Get Custom Field** | `get_custom_field` | Get a custom field by id. | | | **Get Custom Fields** | `get_custom_fields` | Get custom fields for a sub-account (location). | | | **Get Custom Value** | `get_custom_value` | Get a custom value by id. | | | **Get Custom Values** | `get_custom_values` | Get custom values for a sub-account (location). | | | **Get Location Tag By ID** | `get_location_tag_by_id` | Get a location tag by id. | | | **Get Location Tags** | `get_location_tags` | Get tags for a sub-account (location). | | | **Get Recurring Task By ID** | `get_recurring_task_by_id` | Get a recurring task by id. | | | **Get Sub-Account** | `get_location` | Get a sub-account (location) by id. | | | **Get Templates** | `get_location_templates` | Get all or email/SMS templates for a sub-account (location). | | | **Get Timezones** | `get_location_timezones` | Fetch available timezones for a sub-account (location). | | | **Search Location Tasks** | `location_task_search` | Search tasks within a sub-account (location). | | | **Search Sub-Accounts** | `search_locations` | Search sub-accounts (locations). | | | **Update Custom Field** | `update_custom_field` | Update a custom field. | | | **Update Custom Value** | `update_custom_value` | Update a custom value. | | | **Update Location Tag** | `update_location_tag` | Update a location tag. | | | **Update Recurring Task** | `update_recurring_task` | Update a recurring task. | | | **Update Sub-Account** | `put_location` | Update a sub-account (location). | | | **Upload Custom Fields File** | `upload_custom_fields_file` | Upload a file to custom fields (multipart/form-data). | | ### Marketplace | Operation | ID | Description | Trigger | | -------------------------------- | --------------------------------- | ------------------------------------------------------------------------ | ------- | | **Delete Charge** | `delete_marketplace_charge` | Delete a previously raised charge by id. | | | **Get Charge** | `get_specific_marketplace_charge` | Get a single charge by id. | | | **Get Installer Details** | `get_installer_details` | Get installation/installer details for a marketplace app. | | | **Get Rebilling Config For App** | `get_rebilling_config_for_app` | Get the rebilling configuration for an app in a location. | | | **Has Funds** | `marketplace_has_funds` | Check whether the installation has funds available for charging. | | | **List Charges** | `get_marketplace_charges` | List raised charges, optionally filtered by meter/event/user/date. | | | **Migrate Connection** | `migrate_connection` | Migrate an external auth connection into a marketplace app installation. | | | **Raise Charge** | `create_marketplace_charge` | Raise a usage-based (metered) charge for an app installation. | | | **Uninstall Application** | `uninstall_application` | Uninstall a marketplace app from a company or location. | | ### Media library | Operation | ID | Description | Trigger | | ----------------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------ | ------- | | **Bulk Delete/Trash Files/Folders** | `bulk_delete_media_objects` | Bulk soft-delete or trash multiple files and folders. | | | **Bulk Update Files/Folders** | `bulk_update_media_objects` | Bulk update metadata or status of multiple files and folders. | | | **Create Folder** | `create_media_folder` | Create a new folder in the media storage. | | | **Delete File/Folder** | `delete_media_content` | Delete a specific file or folder from media storage. | | | **List Files/Folders** | `fetch_media_content` | Get list of files and folders from the media storage. | | | **Update File/Folder** | `update_media_object` | Update a single file or folder by id. | | | **Upload File** | `upload_media_content` | Upload a file into media storage. If hosted is true, fileUrl is required; else file is required (max 25 MB). | | ### Opportunities | Operation | ID | Description | Trigger | | ----------------------------------- | ------------------------------- | ------------------------------------------------- | ------- | | **Add Followers** | `add_followers_opportunity` | Add followers to an opportunity. | | | **Create Opportunity** | `create_opportunity` | Create an opportunity. | | | **Delete Opportunity** | `delete_opportunity` | Delete an opportunity. | | | **Get Lost Reasons** | `get_opportunity_lost_reason` | Get lost reasons for a location. | | | **Get Opportunity** | `get_opportunity` | Get an opportunity by id. | | | **Get Pipelines** | `get_opportunity_pipelines` | Get pipelines for a location. | | | **Remove Followers** | `remove_followers_opportunity` | Remove followers from an opportunity. | | | **Search Opportunities** | `search_opportunity` | Search opportunities (GET query-param based). | | | **Search Opportunities (Advanced)** | `search_opportunities_advanced` | Search opportunities (POST body based, advanced). | | | **Update Opportunity** | `update_opportunity` | Update an opportunity. | | | **Update Opportunity Status** | `update_opportunity_status` | Update an opportunity's status. | | | **Upsert Opportunity** | `upsert_opportunity` | Upsert (create or update) an opportunity. | | ### Payments | Operation | ID | Description | Trigger | | ------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------- | ------- | | **Create Coupon** | `create_coupon` | Create a coupon. | | | **Create Custom Provider Config** | `create_custom_provider_config` | Create a custom payment provider's connect config (live/test keys). | | | **Create Custom Provider Integration** | `create_custom_provider_integration` | Create a custom payment provider integration. | | | **Create Order Fulfillment** | `create_order_fulfillment` | Create a fulfillment for an order. | | | **Create White-label Integration Provider** | `create_whitelabel_integration_provider` | Create a white-label payment integration provider. | | | **Delete Coupon** | `delete_coupon` | Delete a coupon. | | | **Delete Custom Provider Integration** | `delete_custom_provider_integration` | Delete a custom payment provider integration. | | | **Disconnect Custom Provider Config** | `disconnect_custom_provider_config` | Disconnect a custom payment provider's connect config. | | | **Fetch Custom Provider Config** | `fetch_custom_provider_config` | Fetch a custom payment provider's connect config. | | | **Get Coupon** | `get_coupon` | Get a coupon by id or code. | | | **Get Order** | `get_order_by_id` | Get an order by id. | | | **Get Subscription** | `get_subscription_by_id` | Get a subscription by id. | | | **Get Transaction** | `get_transaction_by_id` | Get a transaction by id. | | | **List Coupons** | `list_coupons` | List coupons. | | | **List Order Fulfillments** | `list_order_fulfillment` | List fulfillments for an order. | | | **List Order Notes** | `list_order_notes` | List notes for an order. | | | **List Orders** | `list_orders` | List orders. | | | **List Subscriptions** | `list_subscriptions` | List subscriptions. | | | **List Transactions** | `list_transactions` | List transactions. | | | **List White-label Integration Providers** | `list_whitelabel_integration_providers` | List white-label payment integration providers. | | | **Record Order Payment** | `record_order_payment` | Record a manual payment against an order. | | | **Update Coupon** | `update_coupon` | Update a coupon. | | | **Update Custom Provider Capabilities** | `update_custom_provider_capabilities` | Update a custom payment provider marketplace app's capabilities. | | ### Phone system | Operation | ID | Description | Trigger | | -------------------------- | ------------------------ | -------------------------------------------------------- | ------- | | **List Active Numbers** | `list_active_numbers` | List active phone numbers for a location. | | | **List Available Numbers** | `list_available_numbers` | List available phone numbers to purchase for a location. | | | **List Number Pools** | `get_number_pool_list` | List phone number pools for a location. | | | **Purchase Phone Number** | `purchase_phone_number` | Purchase a phone number for a location. | | ### Products | Operation | ID | Description | Trigger | | ----------------------------------- | --------------------------------- | --------------------------------------------------------------------- | ------- | | **Bulk Edit Products** | `bulk_edit_products` | Bulk edit products (upsert list of product objects). | | | **Bulk Update Product Reviews** | `bulk_update_product_reviews` | Bulk update product reviews. | | | **Bulk Update Products** | `bulk_update_products` | Bulk update products (price/availability/collection/currency/delete). | | | **Create Price For Product** | `create_price_for_product` | Create a price for a product. | | | **Create Product** | `create_product` | Create a product. | | | **Create Product Collection** | `create_product_collection` | Create a product collection. | | | **Delete Price For Product** | `delete_price_for_product` | Delete a price by id for a product. | | | **Delete Product** | `delete_product` | Delete a product by id. | | | **Delete Product Collection** | `delete_product_collection` | Delete a product collection. | | | **Delete Product Review** | `delete_product_review` | Delete a product review. | | | **Get Price For Product** | `get_price_for_product` | Get a price by id for a product. | | | **Get Product** | `get_product` | Get a product by id. | | | **Get Product Collection** | `get_product_collection` | Get a product collection by id. | | | **Get Product Inventory** | `get_product_inventory` | List product inventory. | | | **Get Product Reviews Count** | `get_product_reviews_count` | Get product reviews count. | | | **Get Product Store Stats** | `get_product_store_stats` | Get product store stats. | | | **List Prices For Product** | `list_prices_for_product` | List prices for a product. | | | **List Product Collections** | `list_product_collections` | List product collections. | | | **List Product Reviews** | `list_product_reviews` | List product reviews. | | | **List Products** | `list_products` | List products for a location (sub-account). | | | **Update Price For Product** | `update_price_for_product` | Update a price by id for a product. | | | **Update Product** | `update_product` | Update a product by id. | | | **Update Product Collection** | `update_product_collection` | Update a product collection. | | | **Update Product Display Priority** | `update_product_display_priority` | Update product display priority within a store. | | | **Update Product Inventory** | `update_product_inventory` | Update product inventory (list of items). | | | **Update Product Review** | `update_product_review` | Update a product review. | | | **Update Product Store Status** | `update_product_store_status` | Update store status for products (include/exclude). | | ### Proposals | Operation | ID | Description | Trigger | | ------------------ | ------------------------- | ------------------------------------------------------------- | ------- | | **List Documents** | `list_proposal_documents` | List proposal/estimate documents & contracts for a location. | | | **List Templates** | `list_proposal_templates` | List proposal/estimate templates for a location. | | | **Send Document** | `send_proposal_document` | Send an existing proposal/contract document. | | | **Send Template** | `send_proposal_template` | Create & optionally send a document from a proposal template. | | ### SaaS | Operation | ID | Description | Trigger | | -------------------------------------------------- | -------------------------------------- | ------------------------------------------------------------------ | ------- | | **Bulk Enable SaaS** | `bulk_enable_saas` | Bulk 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 Locations** | `bulk_disable_saas` | Disable 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-Account** | `enable_saas_location` | Enable 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 Plans** | `get_agency_plans` | Get 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 Details** | `get_location_subscription` | Get 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 ID** | `locations` | Get 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 Locations** | `get_saas_locations` | Get SaaS locations for a company. | | | **Get SaaS Locations (Deprecated)** | `get_saas_locations_deprecated` | \[Deprecated] Get SaaS locations for a company. | | | **Get SaaS Plan** | `get_saas_plan` | Get a SaaS plan by id. | | | **Get SaaS Plan (Deprecated)** | `get_saas_plan_deprecated` | \[Deprecated] Get a SaaS plan by id. | | | **Pause Location** | `pause_location` | Pause or unpause a location. | | | **Pause Location (Deprecated)** | `pause_location_deprecated` | \[Deprecated] Pause or unpause a location. | | | **Update Rebilling** | `update_rebilling` | Update rebilling settings for a company's locations. | | | **Update Rebilling (Deprecated)** | `update_rebilling_deprecated` | \[Deprecated] Update rebilling settings for a company's locations. | | | **Update SaaS Subscription** | `generate_payment_link` | Update SaaS subscription (generate payment link). | | | **Update SaaS Subscription (Deprecated)** | `update_saas_subscription_deprecated` | \[Deprecated] Update SaaS subscription. | | ### Snapshots | Operation | ID | Description | Trigger | | ----------------------------------- | ---------------------------- | ------------------------------------------- | ------- | | **Create Snapshot Share Link** | `create_snapshot_share_link` | Create a share link for a snapshot. | | | **Get Last Snapshot Push** | `get_latest_snapshot_push` | Get the last snapshot push for a location. | | | **Get Snapshot Push Between Dates** | `get_snapshot_push` | Get snapshot push status between two dates. | | | **List Snapshots** | `get_snapshots` | List snapshots for an agency (company). | | ### Social posting | Operation | ID | Description | Trigger | | -------------------------------- | ---------------------------------- | ------------------------------------------------------------------- | ------- | | **Attach Facebook Page** | `attach_facebook_page_group` | Attach a Facebook page/group to the social planner account. | | | **Attach Instagram Account** | `attach_instagram_page_group` | Attach an Instagram account to the social planner account. | | | **Attach LinkedIn Page** | `attach_linkedin_page_profile` | Attach a LinkedIn page/profile to the social planner account. | | | **Attach TikTok Profile** | `attach_tiktok_profile` | Attach a TikTok profile to the social planner account. | | | **Attach Twitter Profile** | `attach_twitter_profile` | Attach a Twitter/X profile to the social planner account. | | | **Bulk Delete Social Posts** | `bulk_delete_social_planner_posts` | Bulk delete social planner posts by ids. | | | **Create Social Post** | `create_social_post` | Create a social planner post. | | | **Delete CSV Post** | `delete_social_csv_post` | Delete a single post from a CSV upload. | | | **Delete CSV Upload** | `delete_social_csv` | Delete a CSV upload and all its posts. | | | **Delete Social Account** | `delete_social_account` | Delete a connected social planner account. | | | **Delete Social Post** | `delete_social_post` | Delete a social planner post by id. | | | **Edit Social Post** | `edit_social_post` | Edit an existing social planner post. | | | **Finalize CSV Upload** | `start_social_csv_finalize` | Start finalizing (scheduling) a CSV upload's posts. | | | **Get CSV Posts** | `get_social_csv_post` | Get the posts contained in a CSV upload. | | | **Get Facebook Pages** | `get_facebook_page_group` | Get Facebook pages/groups for an OAuth account. | | | **Get Google Locations** | `get_google_locations` | Get Google (GMB) locations for an OAuth account. | | | **Get Instagram Accounts** | `get_instagram_page_group` | Get Instagram accounts for an OAuth account. | | | **Get LinkedIn Pages** | `get_linkedin_page_profile` | Get LinkedIn pages/profiles for an OAuth account. | | | **Get Social Category** | `get_social_category` | Get a social planner category by id. | | | **Get Social Media Statistics** | `get_social_media_statistics` | Get social media posting statistics for the given profiles. | | | **Get Social Post** | `get_social_post` | Get a social planner post by id. | | | **Get Social Tags By IDs** | `get_social_tags_by_ids` | Get social planner tags by their ids. | | | **Get TikTok Business Profiles** | `get_tiktok_business_profile` | Get TikTok Business profiles for an OAuth account. | | | **Get TikTok Profiles** | `get_tiktok_profile` | Get TikTok profiles for an OAuth account. | | | **Get Twitter Profiles** | `get_twitter_profile` | Get Twitter/X profiles for an OAuth account. | | | **List CSV Upload Status** | `get_social_csv_upload_status` | List CSV upload statuses for a location. | | | **List Social Accounts** | `get_social_account` | List connected social planner accounts and groups for a location. | | | **List Social Categories** | `get_social_categories` | List social planner categories for a location. | | | **List Social Posts** | `get_social_posts` | Search/list social planner posts. | | | **List Social Tags** | `get_social_tags` | List social planner tags for a location. | | | **Set Google Location** | `set_google_locations` | Attach a Google (GMB) location to the social planner account. | | | **Set Social Accounts** | `set_social_accounts` | Set accounts for a bulk CSV import. | | | **Start Facebook OAuth** | `start_facebook_oauth` | Start the Facebook OAuth connection flow for social planner. | | | **Start Google OAuth** | `start_google_oauth` | Start the Google (GMB) OAuth connection flow for social planner. | | | **Start Instagram OAuth** | `start_instagram_oauth` | Start the Instagram OAuth connection flow for social planner. | | | **Start LinkedIn OAuth** | `start_linkedin_oauth` | Start the LinkedIn OAuth connection flow for social planner. | | | **Start TikTok Business OAuth** | `start_tiktok_business_oauth` | Start the TikTok Business OAuth connection flow for social planner. | | | **Start TikTok OAuth** | `start_tiktok_oauth` | Start the TikTok OAuth connection flow for social planner. | | | **Start Twitter OAuth** | `start_twitter_oauth` | Start the Twitter/X OAuth connection flow for social planner. | | | **Upload Social CSV** | `upload_social_csv` | Upload a CSV of posts for bulk scheduling (multipart file upload). | | ### Store | Operation | ID | Description | Trigger | | -------------------------------- | ------------------------------ | ------------------------------------------------ | ------- | | **Create Shipping Carrier** | `create_shipping_carrier` | Create a shipping carrier for a location. | | | **Create Shipping Rate** | `create_shipping_rate` | Create a shipping rate within a shipping zone. | | | **Create Shipping Zone** | `create_shipping_zone` | Create a shipping zone for a location. | | | **Create/Update Store Settings** | `create_store_setting` | Create or update store settings for a location. | | | **Delete Shipping Carrier** | `delete_shipping_carrier` | Delete a shipping carrier. | | | **Delete Shipping Rate** | `delete_shipping_rate` | Delete a shipping rate. | | | **Delete Shipping Zone** | `delete_shipping_zone` | Delete a shipping zone. | | | **Get Available Shipping Rates** | `get_available_shipping_rates` | Get available shipping rates for a cart / order. | | | **Get Shipping Carrier** | `get_shipping_carrier` | Get a shipping carrier by id. | | | **Get Shipping Rate** | `get_shipping_rate` | Get a shipping rate by id. | | | **Get Shipping Zone** | `get_shipping_zone` | Get a shipping zone by id. | | | **Get Store Settings** | `get_store_settings` | Get store settings for a location. | | | **List Shipping Carriers** | `list_shipping_carriers` | List shipping carriers for a location. | | | **List Shipping Rates** | `list_shipping_rates` | List shipping rates within a shipping zone. | | | **List Shipping Zones** | `list_shipping_zones` | List shipping zones for a location. | | | **Update Shipping Carrier** | `update_shipping_carrier` | Update a shipping carrier. | | | **Update Shipping Rate** | `update_shipping_rate` | Update a shipping rate. | | | **Update Shipping Zone** | `update_shipping_zone` | Update a shipping zone. | | ### Surveys | Operation | ID | Description | Trigger | | -------------------------- | ------------------------- | -------------------------------------- | ------- | | **Get Survey Submissions** | `get_surveys_submissions` | Get survey submissions for a location. | | | **Get Surveys** | `get_surveys` | List surveys for a location. | | ### Trigger links | Operation | ID | Description | Trigger | | ------------------------ | ---------------------- | ---------------------------------------- | ------- | | **Create Link** | `create_link` | Create a trigger link within a location. | | | **Delete Link** | `delete_link` | Delete a trigger link. | | | **Get Link by ID** | `get_link_by_id` | Get a trigger link by id. | | | **List Links** | `get_links` | List trigger links for a location. | | | **Search Trigger Links** | `search_trigger_links` | Search trigger links for a location. | | | **Update Link** | `update_link` | Update a trigger link. | | ### Users | Operation | ID | Description | Trigger | | -------------------------- | ----------------------- | ---------------------------------------- | ------- | | **Create User** | `create_user` | Create a user. | | | **Delete User** | `delete_user` | Delete a user. | | | **Filter Users by Email** | `filter_users_by_email` | Filter users by a list of emails. | | | **Get User** | `get_user` | Get a user by id. | | | **List Users by Location** | `get_user_by_location` | List users for a location (sub-account). | | | **Search Users** | `search_users` | Search users within a company. | | | **Update User** | `update_user` | Update a user. | | ### Voice AI | Operation | ID | Description | Trigger | | --------------------------- | ------------------------ | ------------------------------------ | ------- | | **Create Voice AI Action** | `create_voice_ai_action` | Create a Voice AI agent action. | | | **Create Voice AI Agent** | `create_voice_ai_agent` | Create a Voice AI agent. | | | **Delete Voice AI Action** | `delete_voice_ai_action` | Delete a Voice AI agent action. | | | **Delete Voice AI Agent** | `delete_voice_ai_agent` | Delete a Voice AI agent. | | | **Get Voice AI Action** | `get_voice_ai_action` | Get a Voice AI agent action by id. | | | **Get Voice AI Agent** | `get_voice_ai_agent` | Get a Voice AI agent by id. | | | **Get Voice AI Call Log** | `get_voice_ai_call_log` | Get a Voice AI call log by id. | | | **List Voice AI Agents** | `get_voice_ai_agents` | List Voice AI agents for a location. | | | **List Voice AI Call Logs** | `get_voice_ai_call_logs` | List Voice AI call logs. | | | **Patch Voice AI Agent** | `patch_voice_ai_agent` | Patch (update) a Voice AI agent. | | | **Update Voice AI Action** | `update_voice_ai_action` | Update a Voice AI agent action. | | ### Workflows | Operation | ID | Description | Trigger | | ------------------ | -------------- | -------------------------------------------- | ------- | | **List Workflows** | `get_workflow` | List workflows for a location (sub-account). | | ### Other | Operation | ID | Description | Trigger | | --------------------------------------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | **On Any Webhook Event** | `on_webhook` | Catch-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 Installed** | `on_app_install` | | Yes | | **On App Uninstalled** | `on_app_uninstall` | | Yes | | **On App Updated** | `on_app_update` | | Yes | | **On Appointment Created** | `on_appointment_create` | | Yes | | **On Appointment Deleted** | `on_appointment_delete` | | Yes | | **On Appointment Updated** | `on_appointment_update` | | Yes | | **On Association Created** | `on_association_create` | | Yes | | **On Association Deleted** | `on_association_delete` | | Yes | | **On Association Updated** | `on_association_update` | | Yes | | **On Campaign Status Changed** | `on_campaign_status_update` | | Yes | | **On Contact Created** | `on_contact_create` | | Yes | | **On Contact Deleted** | `on_contact_delete` | | Yes | | **On Contact DND Updated** | `on_contact_dnd_update` | | Yes | | **On Contact Tags Updated** | `on_contact_tag_update` | | Yes | | **On Contact Updated** | `on_contact_update` | | Yes | | **On Conversation Unread Change** | `on_conversation_unread` | | Yes | | **On Conversation Updated** | `on_conversation_update` | | Yes | | **On Email Stats (delivered/opened/clicked)** | `on_email_stats` | | Yes | | **On External Auth Connected** | `on_external_auth_connected` | | Yes | | **On Inbound Message** | `on_inbound_message` | | Yes | | **On Invoice Created** | `on_invoice_create` | | Yes | | **On Invoice Deleted** | `on_invoice_delete` | | Yes | | **On Invoice Paid** | `on_invoice_paid` | | Yes | | **On Invoice Partially Paid** | `on_invoice_partially_paid` | | Yes | | **On Invoice Sent** | `on_invoice_sent` | | Yes | | **On Invoice Updated** | `on_invoice_update` | | Yes | | **On Invoice Voided** | `on_invoice_void` | | Yes | | **On Knowledge Base Created** | `on_knowledge_base_create` | | Yes | | **On Knowledge Base Deleted** | `on_knowledge_base_delete` | | Yes | | **On Knowledge Base FAQ Changed** | `on_knowledge_base_faq_change` | | Yes | | **On Knowledge Base File Changed** | `on_knowledge_base_file_change` | | Yes | | **On Knowledge Base Table Changed** | `on_knowledge_base_table_file_change` | | Yes | | **On Knowledge Base Text Changed** | `on_knowledge_base_rich_text_change` | | Yes | | **On Knowledge Base Updated** | `on_knowledge_base_update` | | Yes | | **On Knowledge Base URL Trained** | `on_knowledge_base_trained_url_change` | | Yes | | **On Note Created** | `on_note_create` | | Yes | | **On Note Deleted** | `on_note_delete` | | Yes | | **On Note Updated** | `on_note_update` | | Yes | | **On Object Schema Created** | `on_object_schema_create` | | Yes | | **On Object Schema Updated** | `on_object_schema_update` | | Yes | | **On Opportunity Assignee Changed** | `on_opportunity_assigned_to_update` | | Yes | | **On Opportunity Created** | `on_opportunity_create` | | Yes | | **On Opportunity Deleted** | `on_opportunity_delete` | | Yes | | **On Opportunity Stage Changed** | `on_opportunity_stage_update` | | Yes | | **On Opportunity Status Changed** | `on_opportunity_status_update` | | Yes | | **On Opportunity Updated** | `on_opportunity_update` | | Yes | | **On Opportunity Value Changed** | `on_opportunity_monetary_value_update` | | Yes | | **On Order Created** | `on_order_create` | | Yes | | **On Order Status Changed** | `on_order_status_update` | | Yes | | **On Outbound Message** | `on_outbound_message` | | Yes | | **On Price Created** | `on_price_create` | | Yes | | **On Price Deleted** | `on_price_delete` | | Yes | | **On Price Updated** | `on_price_update` | | Yes | | **On Product Created** | `on_product_create` | | Yes | | **On Product Deleted** | `on_product_delete` | | Yes | | **On Product Updated** | `on_product_update` | | Yes | | **On Provider Outbound Message** | `on_provider_outbound_message` | | Yes | | **On Record Created** | `on_record_create` | | Yes | | **On Record Deleted** | `on_record_delete` | | Yes | | **On Record Updated** | `on_record_update` | | Yes | | **On Relation Created** | `on_relation_create` | | Yes | | **On Relation Deleted** | `on_relation_delete` | | Yes | | **On SaaS Plan Changed** | `on_plan_change` | | Yes | | **On SaaS Plan Created** | `on_saas_plan_create` | | Yes | | **On Sub-Account Created** | `on_location_create` | | Yes | | **On Sub-Account Updated** | `on_location_update` | | Yes | | **On Task Completed** | `on_task_complete` | | Yes | | **On Task Created** | `on_task_create` | | Yes | | **On Task Deleted** | `on_task_delete` | | Yes | | **On User Created** | `on_user_create` | | Yes | | **On User Deleted** | `on_user_delete` | | Yes | | **On User Updated** | `on_user_update` | | Yes | | **On Voice AI Call Ended** | `on_voice_ai_call_end` | | Yes |