Check Account Funds
Checks if the GoHighLevel account has sufficient funds to cover marketplace charges. Use this action when you need to verify whether an account has adequate balance before initiating marketplace purchases, billing operations, or any transaction that requires funds to be available. This is a read-only operation that simply queries the current fund status. Required headers (handled automatically): Version: 2021-07-28
Create Brand Voice
Creates a new brand voice for the specified location in GoHighLevel. Use this action when you need to define a brand voice with a name, tone, target audience, and customer pain points to represent the brand's communication style. Required headers (handled automatically): Version: 2021-07-28
Create Calendars Service Location
Creates a new service location for the calendar services. Use this action when you need to add a new service location within a location in GoHighLevel. The service location will be associated with the location identified by the location_id parameter and will be accessible via the calendars API. Required headers (handled automatically): Content-Type: application/json, Version: 2021-07-28
Create Email Template Folder
Creates a new email template folder for the specified location. Use this action when you need to create a folder to organize email templates within a location in GoHighLevel. The folder will be associated with the location identified by the location_id parameter. This action is useful for organizing email templates into logical categories. Required headers (handled automatically): Version: 2021-07-28
Create FAQ
Creates a new FAQ inside a knowledge base. Use this action when you need to add a new question and answer pair to a knowledge base in GoHighLevel. The FAQ will be associated with the location and knowledge base identified by the provided IDs. Required headers (handled automatically): Content-Type: application/json, Version: 2021-04-15
Create Media Folder
Creates a new folder in the media storage for a location. Use this action when you need to organize media files by creating a new folder in the GoHighLevel media library. The folder can be created at the root level or as a nested folder under an existing parent folder.
Create Product
Creates a new product with the specified details in the HighLevel system. Use this action when you need to add a new product to a location in HighLevel, such as creating a service, digital product, or physical item with associated pricing, variants, and tax configurations.
Create Tag
Creates a new tag for the specified location. Use this action when you need to create a tag within a location in GoHighLevel. The tag will be associated with the location identified by the location_id parameter. Required headers (handled automatically): Version: 2021-07-28
Delete Agent
Deletes an agent and all its versions from Agent Studio. Use this action when you need to permanently remove an AI agent and all its associated versions from GoHighLevel's Agent Studio. This action is irreversible — once the agent is deleted, it cannot be recovered, including all its versions.
Delete Association
Deletes a user-defined association by its ID. Deleting an association will also delete all the relations for that association. Use this action when you need to remove a specific association and all its associated relations from the system. This action is irreversible — once the association is deleted, it cannot be recovered.
Delete Business
Deletes a business by its unique identifier. Use this action when you need to permanently remove a business and all its associated data from the HighLevel system. This action is irreversible — once the business is deleted, it cannot be recovered. Required headers (handled automatically): Version: 2021-07-28
Delete Service Booking
Deletes a service booking by its ID from the GoHighLevel calendar system. Use this action when you need to permanently remove a service booking from a calendar. This action is irreversible — once the booking is deleted, it cannot be recovered. Required headers (handled automatically): Version: 2021-07-28
Delete Conversation AI Agent Action
Permanently deletes an action from a conversation AI agent. This will remove the action from all associated agents and cannot be undone. Use this action when you need to permanently remove an action from a conversation AI agent in GoHighLevel. This action is irreversible — once the action is deleted, it cannot be recovered and will be removed from all associated agents. Required headers (handled automatically): Version: 2021-07-28
Delete Email Template
Deletes an email template by its ID for a specified location. Use this action when you need to permanently remove an email template from GoHighLevel. This action is irreversible — once the email template is deleted, it cannot be recovered. Required headers (handled automatically): Version: 2021-07-28
Delete Event Notification
Deletes a notification from a calendar by removing the specified notification ID. Use this action when you need to permanently remove a calendar notification from the GoHighLevel system. This action is irreversible — once the notification is deleted, it cannot be recovered. Required headers (handled automatically): Version: 2021-04-15
Delete Knowledge Base Trained Pages
Deletes trained pages from a knowledge base by their URL identifiers. Use this action when you need to remove specific trained pages from a knowledge base in GoHighLevel. This action is irreversible — once the trained pages are deleted, they cannot be recovered. Required headers (handled automatically): Content-Type: application/json, Version: 2021-07-28
Delete Link
Deletes a link by its unique identifier. Use this action when you need to permanently remove a link from the HighLevel system. This action is irreversible — once the link is deleted, it cannot be recovered. Required headers (handled automatically): Version: 2021-07-28
Delete Media
Deletes a specific file or folder from the media storage by its unique identifier. Use this action when you need to permanently remove a media file or folder from the HighLevel media library. This action requires the media object ID and the owning location information. This action is irreversible — once the media is deleted, it cannot be recovered. Required headers (handled automatically): Version: 2021-07-28
Delete Object Record
Deletes a record by its ID from a specified object schema (business or custom objects). Use this action when you need to permanently remove a specific record from the HighLevel objects system. This action is irreversible — once the record is deleted, it cannot be recovered. Supported objects include business objects and custom objects. For custom objects, include the 'custom_objects.' prefix in the schemaKey parameter. Required headers (handled automatically): Version: 2021-07-28
Delete Product Review
Deletes a product review by its unique identifier. Use this action when you need to permanently remove a product review from the HighLevel system. This action is irreversible — once the product review is deleted, it cannot be recovered. Required headers (handled automatically): Version: 2021-07-28
Delete Relation
Deletes a relation between two objects by its ID. Use this action when you need to remove a specific relation from the system. This action is irreversible — once the relation is deleted, it cannot be recovered. Required headers (handled automatically): Version: 2021-07-28
Delete Store Shipping Zone
Deletes a shipping zone by its unique identifier. Use this action when you need to permanently remove a shipping zone from the HighLevel store. This action is irreversible — once the shipping zone is deleted, it cannot be recovered. Required headers (handled automatically): Version: 2021-07-28
Fetch Email Templates
Fetches email templates for the specified location from the GoHighLevel email builder. Use this action when you need to retrieve a list of email templates available in a location. The locationId parameter is required to identify which location's templates to fetch. This action returns templates from the email builder including their names, subjects, categories, and other metadata. Required headers (handled automatically): Version: 2021-07-28
Find Associations
Retrieves all associations for a sub-account / location. Use this action when you need to list or discover all associations defined within a specific location, including custom object associations and their relations. This is a read-only action that returns existing associations without making any modifications. Required headers (handled automatically): Version: 2021-07-28
Generate Estimate Number
Generates the next estimate number for the given location. Use this action when you need to retrieve the next available estimate number before creating a new estimate. This is a read-only action that does not modify any data - it simply returns the next estimate number based on the location's current state. Required headers (handled automatically): Version: 2021-07-28
Get Agent Studio Agents (Deprecated)
Lists all active agents with a published production version for the specified location. Use this action when you need to retrieve all agents available in GoHighLevel's Agent Studio for a specific location. Note: This is a deprecated endpoint. Consider using GET /agent instead for new integrations.
Get All Notes
Retrieves all notes associated with a specific contact. Use this action when you need to fetch all notes for a contact in GoHighLevel, such as to review communication history or track important information about a contact. Required headers (handled automatically): Version: 2021-07-28
Get All Tasks
Retrieves all tasks associated with a specific contact. Use this action when you need to fetch all tasks for a contact in GoHighLevel, such as to track pending activities, follow-ups, or completed work related to a contact. Required headers (handled automatically): Version: 2021-07-28
Get Blogs
Retrieves all blogs for a specific location ID. Use this action when you need to fetch all blogs associated with a GoHighLevel location, such as to display a list of blogs on a website or manage blog content for a specific location. This is a read-only action that retrieves existing blogs without modification. Required headers (handled automatically): Version: 2021-07-28
Get Brand Boards
Retrieves all brand boards for a specific location. Use this action when you need to fetch all brand boards associated with a location in GoHighLevel, including their logos, colors, and fonts. This is a read-only action that retrieves existing brand boards without modification.
Get Brand Voice
Retrieves a brand voice by its ID within the specified location. Use this action when you need to fetch details of a specific brand voice, including its name, description, and sample content that represents the brand's tone and communication style. This is a read-only action that retrieves existing brand voice data without modification.
Get Calendar
Retrieves a single calendar by its unique identifier. Use this action when you need to fetch the full details of a specific GoHighLevel calendar, including its booking rules, availability settings, team member assignments, and integration configurations. Required headers (handled automatically): Version: 2021-04-15
Get Calendars
Retrieves all calendars associated with a GoHighLevel location. Use this action when you need to list all booking calendars available in a GoHighLevel location, including their configuration details, availability settings, and team member assignments. Required headers (handled automatically): Version: 2021-04-15
Get Calendar Appointment
Retrieves details for a specific calendar appointment or event by its ID. Use this action when you need to fetch detailed information about a single appointment in GoHighLevel, such as to view booking details, check appointment status, or retrieve meeting information for a scheduled event. For recurring appointments, pass the masterEventId in the eventId field to access the original series. Individual instance IDs retrieve details for specific occurrences. Required headers (handled automatically): Version: 2021-04-15
Get Event Calendar Schedule
Retrieves the availability schedule for a specific event calendar. Use this action when you need to fetch the availability schedule configuration for an event calendar in GoHighLevel, including custom availabilities, open hours, recurring settings, and buffer times. Required headers (handled automatically): Version: 2021-04-15
Get Service Bookings
Retrieves service bookings for a location within a given date range, with an optional service location filter. Use this action when you need to fetch a list of booked service appointments for a GoHighLevel location, such as to view all upcoming or historical bookings, generate reports, or sync booking data with an external system. The startTime and endTime parameters define the date range for the query. Both are required and must be in ISO 8601 format. Optionally filter by serviceLocationId to narrow results to a specific service location. Required headers (handled automatically): Version: 2021-04-15
Get Conversation
Retrieves a specific conversation by its unique identifier. Use this action when you need to fetch the details of a particular conversation in GoHighLevel, including its status, assigned user, contact information, and metadata. This is a read-only action that retrieves an existing conversation without modification.
Get Conversation Messages
Retrieves all messages for a specific conversation in GoHighLevel. Use this action when you need to fetch the message history of a conversation to review communication details or track the history of interactions with a contact. Required headers (handled automatically): Version: 2021-04-15
Get Custom Values
Retrieves all custom values associated with a specific location in GoHighLevel. Use this action when you need to fetch all custom field values configured for a location, such as to access location-specific custom data or display custom field information in an integrated application. Required headers (handled automatically): Version: 2021-07-28
Get Bulk Action Campaigns
Retrieves all bulk action campaigns for a specific GoHighLevel location. Use this action when you need to list email campaigns that use bulk actions for a location, such as to view available campaigns, check their status, or identify campaigns for enrollment purposes. This is a read-only action that retrieves existing campaigns without modification. Required headers (handled automatically): Version: 2021-07-28
Get Email Campaigns
Retrieves all email campaigns for a specific GoHighLevel location. Use this action when you need to list all email marketing campaigns associated with a location, such as to review campaign statuses, track campaign performance metrics, or select a specific campaign for further operations. This is a read-only action that retrieves existing email campaigns without modification. Required headers (handled automatically): Version: 2021-07-28
Get Email Templates
Retrieves all email templates for a specific location. Use this action when you need to fetch all email templates available in a GoHighLevel location, including their content, subjects, and metadata. This is a read-only action that retrieves existing email templates without modification. The templates can be used for email campaigns, automations, and other communications. Required headers (handled automatically): Version: 2021-07-28
Get Event Notification
Retrieves a single event notification by its unique notification ID. Use this action when you need to fetch the details of a specific calendar notification, including its delivery channel, timing configuration, and recipient settings in the GoHighLevel system. Required headers (handled automatically): Version: 2021-04-15
Get Funnels Page
Retrieves a list of all funnel pages based on the given query parameters. Use this action when you need to fetch all pages belonging to a specific funnel in GoHighLevel, such as to display funnel page information, manage funnel content, or retrieve page details for a marketing funnel. This is a read-only action that retrieves existing funnel pages without modification. Required headers (handled automatically): Version: 2021-07-28
Get Funnels Page Count
Retrieves the count of funnel pages based on the given query parameters. Use this action when you need to get the number of pages in a specific funnel in GoHighLevel, such as to determine pagination requirements or to display page counts in a UI. Required headers (handled automatically): Version: 2021-07-28
Get Invoice Settings
Retrieves invoice settings for a specific location in GoHighLevel. Use this action when you need to fetch the invoice configuration for a location, such as to display invoice templates, check default terms, or verify tax settings. Required headers (handled automatically): Version: 2021-07-28
Get Invoice Schedules
Retrieves a list of invoice schedules for a location or company. Use this action when you need to fetch all invoice schedules from GoHighLevel, such as to list recurring billing schedules, view scheduled payment plans, or filter schedules by status, date range, or other criteria. Required headers (handled automatically): Version: 2021-07-28
Get Rebilling Config for App
Retrieves rebilling configuration for an app subscription, including subscription and usage plans for the authenticated sub-account. Use this action when you need to fetch the rebilling settings, available plans, and usage-based pricing configuration for a marketplace app installed in a specific location. This is a read-only action that retrieves existing rebilling configuration without modification.
List Media Files
Fetches a list of files and folders from the media storage for a location. Use this action when you need to retrieve the contents of the media library, browse folders, or search for specific files. The results can be filtered by type (file/folder), sorted by various fields, and paginated using offset and limit. Required headers (handled automatically): Version: 2021-07-28
Get Object Schema
Retrieves the schema definition for an object by its key or ID in GoHighLevel. Use this action when you need to fetch the field structure and metadata for objects such as contacts, opportunities, businesses, or custom objects. This is a read-only operation that returns the schema definition including all field properties like data types, labels, and constraints. Required headers (handled automatically): Version: 2021-07-28 Supported object keys: contact, opportunity, business, and custom object keys.
Get Object Record By Id
Retrieves a Standard Object (like business) or Custom Object record by its ID. Use this action when you need to fetch a specific record from the HighLevel objects system by providing the schema key and record ID. This is a read-only action that retrieves record data without making any modifications. Supported objects include business objects and custom objects. For custom objects, include the 'custom_objects.' prefix in the schemaKey parameter. Required headers (handled automatically): Version: 2021-07-28
Get Pipelines
Retrieves all opportunity pipelines associated with a GoHighLevel location. Use this action when you need to list all sales/opportunity pipelines available in a GoHighLevel location, including their stages, display settings, and probability configurations. Required headers (handled automatically): Version: 2021-07-28
Get Posts
Retrieves a list of social media posts for a specific location. Use this action when you need to fetch social media posts from GoHighLevel, such as to review scheduled content, monitor published posts, check failed posts, or manage social media content across different platforms. This is a read-only action that retrieves existing posts without modification. Required headers (handled automatically): Version: 2021-07-28
List Products
Retrieves a paginated list of products for a specific location. Use this action when you need to fetch and explore product information from GoHighLevel, such as to display a product catalog, search for specific products by name, or paginate through available products. Supports filtering by product name, category (collection), store, and various product attributes. Also supports pagination using limit and offset parameters for efficient data retrieval. Required headers (handled automatically): Version: 2021-07-28
List Product Prices
Lists all prices associated with a specific product in the HighLevel system. Use this action when you need to retrieve pricing information for a product, including both one-time and recurring prices, with optional filtering by price IDs and pagination support for large result sets. Required headers (handled automatically): Version: 2021-07-28
Get Relations By Record Id
Retrieves all relations for a specific record by its ID. Use this action when you need to find or list all relations associated with a specific record, such as contacts, custom objects, or opportunities. This is a read-only action that returns existing relations without making any modifications. Required headers (handled automatically): Version: 2021-07-28
Get Specific Charge
Retrieves specific wallet charge details by charge ID. Use this action when you need to fetch details of a particular charge transaction, including the amount, currency, units, and refund status from the GoHighLevel marketplace billing system. This is a read-only action that retrieves an existing charge without modification. Required headers (handled automatically): Version: 2021-07-28
Get Store Settings
Retrieves store settings for a specific location or agency. Use this action when you need to fetch the store configuration and settings for a GoHighLevel location, such as shipping origins, order notifications, and fulfillment settings. Required headers (handled automatically): Version: 2021-07-28
Get Timezones
Retrieves all available timezones for a GoHighLevel location. Use this action when you need to fetch the list of supported timezones, such as to display timezone options in scheduling interfaces or configure location-specific time settings. Required headers (handled automatically): Version: 2021-07-28
Get User By Location
Retrieves all users associated with a specific location in GoHighLevel. Use this action when you need to fetch the list of users belonging to a location, such as to view team members, check user details, or enumerate available users for task assignments. This is a read-only action that retrieves existing users without modification. Required headers (handled automatically): Version: 2021-07-28
List Agent Studio Agents
Lists all active agents for the specified location in Agent Studio. Use this action when you need to retrieve all agents available for a location in GoHighLevel's Agent Studio. The locationId parameter is required to ensure optimal performance. Supports pagination using limit and offset parameters. Optionally filter by isPublished=true to return only agents with a published production version. Required headers (handled automatically): Version: 2021-07-28
List Brand Voices
Retrieves all brand voices for a specific location in GoHighLevel. Use this action when you need to fetch all brand voices associated with a location, including their names, descriptions, and sample content that represent the brand's tone. This is a read-only action that retrieves existing brand voices without modification.
List Conversation AI Agent Actions
Lists all actions configured for a specific conversation AI agent. Use this action when you need to retrieve the complete list of actions available for an agent in GoHighLevel's Conversation AI. This is a read-only action that returns all configured actions without modification. The agentId parameter is required to specify which agent's actions to retrieve. Required headers (handled automatically): Version: 2021-07-28
List Funnels Funnel
Retrieves a list of all funnels based on the given query parameters. Use this action when you need to fetch all funnels available in a GoHighLevel location, such as to display funnel information, manage funnel content, or retrieve funnel details for marketing campaigns. This is a read-only action that retrieves existing funnels without modification. Required headers (handled automatically): Version: 2021-07-28
List Coupons
Retrieves a list of all coupons available in a GoHighLevel location. Use this action when you need to view all promotional offers and special discounts available in a GoHighLevel location. Supports filtering by status (scheduled, active, expired) and searching by coupon name or code. Use pagination parameters to retrieve large result sets. Required headers (handled automatically): Version: 2021-07-28
List Proposals Templates
Lists all proposal, estimate, and content library document templates for a location. Use this action when you need to retrieve all available document contract templates in a GoHighLevel location. This includes proposals, estimates, and content library templates that can be sent to contacts. The templates can be filtered by type, creation date, name, and public document status. This is a read-only action that retrieves existing templates without modification. Required headers (handled automatically): Version: 2021-07-28
Remove Contact From Every Campaign
Removes a contact from all campaigns they are enrolled in. Use this action when you need to unenroll a contact from all marketing campaigns in GoHighLevel. This action is irreversible — the contact will be removed from all campaigns and would need to be re-enrolled manually if needed. Required headers (handled automatically): Version: 2021-07-28
Search Conversation AI Agents
Searches for AI agents based on various criteria including name, status, and configuration. Use this action when you need to find conversation AI agents in GoHighLevel with support for advanced filtering and full-text search capabilities. Supports filtering by location, name, status, and full-text search across agent names and descriptions. Results are paginated using limit and offset parameters. Required headers (handled automatically): Version: 2021-07-28
Search Conversations
Returns a list of all conversations matching the search criteria along with the sort and filter options selected. Use this action when you need to search and retrieve conversations from GoHighLevel with various filtering options such as status, assigned user, contact, message type, direction, and more. Required headers (handled automatically): Version: 2021-04-15 At least `locationId` is required to perform the search. Additional filters can narrow down results based on assigned users, followers, mentions, contact details, message characteristics, and conversation status.
Search Duplicate Contact
Searches for duplicate contacts in a GoHighLevel location. Use this action when you need to find contacts that may already exist in the system before creating a new contact. If `Allow Duplicate Contact` is disabled under Settings, the global unique identifier will be used for searching the contact. If the setting is enabled, first priority for search is `email` and the second priority will be `phone`. At least one of `email` or `number` should be provided for the search to return meaningful results. If neither is provided, an empty list may be returned. Required headers (handled automatically): Version: 2021-07-28
Search Links
Searches for trigger links within a GoHighLevel location. Use this action when you need to find or retrieve a list of trigger links based on search criteria. The search supports filtering by a query string and pagination via skip/limit parameters. Results are scoped to the specified location ID. Required headers (handled automatically): Version: 2021-04-15
Set Default Brand Voice
Sets a brand voice as the default for a location. Use this action when you need to designate a specific brand voice as the default for a location, which automatically unsets the previous default brand voice. This action is idempotent - setting the same brand voice as default multiple times will return a successful response.
Update Association
Updates the labels of an association by its ID. This action allows you to modify the firstObjectLabel and secondObjectLabel of an existing association. Use this action when you need to update the label configuration of an existing association in a specific location/sub-account. Required headers (handled automatically): Version: 2021-07-28
Update Business
Updates an existing business with the provided information. Use this action when you need to modify details of an existing business entity within the HighLevel system. All fields except business_id are optional. Only provide the fields you want to update; omitted fields will retain their current values. Required headers (handled automatically): Version: 2021-07-28
Update Calendar
Updates an existing calendar by its unique identifier. Use this action when you need to modify the settings, availability, team member assignments, or other configurations of an existing GoHighLevel booking calendar. Only include the fields you want to change — all fields except calendarId are optional. Required headers (handled automatically): Version: 2021-04-15
Update Calendar Schedule
Updates an existing calendar's availability schedule. Use this action when you need to modify the availability rules, open hours, recurring settings, or buffer times for a GoHighLevel calendar. All fields are optional—only provided fields will be updated. Required headers (handled automatically): Version: 2021-04-15
Update Event Calendar Schedule
Updates the availability schedule for a specific event calendar. Use this action when you need to modify the availability schedule configuration for an event calendar in GoHighLevel, including timezone settings and availability rules. Only the fields provided in the request body will be modified; unspecified fields retain their current values. Required headers (handled automatically): Version: 2021-07-28, Content-Type: application/json
Update Service Booking
Updates an existing service booking in GoHighLevel. Use this action when you need to modify details of an existing appointment or service booking, such as rescheduling the time, changing the status, updating the assigned team member, or modifying notes and custom fields. This action requires the booking ID and supports updating various booking attributes including title, start/end times, status, notes, address, assigned user, guests, and custom fields. Required headers (handled automatically): Content-Type: application/json, Version: 2021-04-15
Update Conversation AI Agent
Updates an existing conversation AI agent's configuration in GoHighLevel. You can modify the agent's name, goal, personality, instructions, status, and actions. This action modifies the existing agent configuration at the specified location. Use this action when you need to modify an existing conversation AI agent's settings, update its behavior instructions, change its status, or update the actions it can perform. All fields except agentId are optional — only include the fields you want to update. The agentId parameter is required to identify which agent to update. Required headers (handled automatically): Version: 2021-07-28
Update Conversation
Updates the conversation details based on the conversation ID. Use this action when you need to modify properties of an existing conversation, such as marking it as starred or updating the unread count. This action requires a valid conversation_id and location_id. Note that some field updates may be irreversible depending on the conversation state.
Update Conversation Message Attachments
Set attachments on an existing conversation message, replacing any existing attachments. Use this action when you need to update or add attachments to an existing message in GoHighLevel conversations. This operation replaces all existing attachments with the new ones provided. Supported for "Custom Call" message type only. Maximum 5 URLs per request. This action is irreversible — existing attachments will be permanently replaced.
Update Email Template
Updates an existing email template for the specified location. Use this action when you need to modify an email template's name, subject, content, or other properties. All request body fields are optional - only include the fields you want to update. The template will be associated with the specified location and template ID. Required headers (handled automatically): Version: 2021-07-28
Update Estimate Template
Updates an existing estimate template by its unique identifier. Use this action when you need to modify an existing estimate template's name, business details, items, discount, or other properties. This action requires the Version header to be set to 2021-07-28, which is handled automatically. Required OAuth scope: invoices/estimate.write
Update Estimate Last Visited At
Updates the last visited at timestamp for an estimate. Use this action when you need to record when a contact or user last viewed an estimate. This is useful for tracking customer engagement with estimates. Note: This action requires the Version header to be set to 2021-07-28, which is handled automatically.
Update Invoice Schedule
Updates an existing invoice schedule by its unique identifier. Use this action when you need to modify an existing invoice schedule's name, contact details, schedule timing, business details, items, discount, or other properties. This action requires the Version header to be set to 2021-07-28, which is handled automatically. Required OAuth scope: invoices/schedule.write
Update Knowledge Base
Updates a knowledge base by its unique identifier. Use this action when you need to modify the name, status, or other properties of an existing knowledge base in GoHighLevel. Only fields provided in the request body will be updated; unspecified fields retain their current values. Required headers (handled automatically): Content-Type: application/json, Version: 2021-07-28
Bulk Delete Media Files
Bulk soft-deletes or trashes multiple files and folders in a single request. Use this action when you need to efficiently remove multiple media items at once by setting their status to either 'deleted' or 'trashed'. This operation affects only the specified files and does not permanently remove them from the system. This action is irreversible — files that are deleted or trashed cannot be recovered through this action. Consider using this for batch cleanup operations where you need to remove multiple media files from the HighLevel media library. Required headers (handled automatically): Version: 2021-07-28
Bulk Update Media Files
Updates metadata or status of multiple files and folders in bulk. Use this action when you need to rename multiple media files or folders in a single request. This action requires the location ID (altId), the entity type (altType), and an array of file objects containing their IDs and optional new names. Note: This is an update (not create) operation — only the name field can be modified; other metadata retains its current values. Required headers (handled automatically): Version: 2021-07-28
Update Product Review
Updates the status, reply, and other details of a product review. Use this action when you need to moderate, respond to, or modify an existing product review in the HighLevel system. This action allows updating the review status (approved/pending/rejected), adding a reply, or modifying the review headline, detail, and rating. Required headers (handled automatically): Version: 2021-07-28
Update Tag
Updates an existing tag for the specified location. Use this action when you need to modify a tag's name within a location in GoHighLevel. The tag will be updated in the location identified by the location_id parameter. Required headers (handled automatically): Version: 2021-07-28
Update Task Completed
Updates the completed status of a task associated with a contact. Use this action when you need to mark a task as completed or uncompleted for a specific contact in GoHighLevel. This action modifies the completion status of an existing task identified by its ID. Required headers (handled automatically): Version: 2021-07-28, Content-Type: application/json
Update Voice AI Agent
Partially updates an existing voice AI agent's configuration. Use this action when you need to modify specific settings of a voice AI agent in GoHighLevel, such as updating the agent name, prompt, voice settings, working hours, or notification preferences. This is a partial update operation — only the fields provided in the request body will be modified; unspecified fields retain their current values. Required headers (handled automatically): Version: 2021-04-15
Upload File to Custom Fields
Upload files to custom fields. Use when you need to attach files to contacts, opportunities, or custom object records via custom field file upload functionality. The 'id' parameter should be the ID of the Contact, Opportunity, or Custom Field that the file should be associated with. The actual file field within the custom field configuration will be updated with the uploaded file URL. Required headers (handled automatically): Version: 2021-07-28
Upload Media File
Upload a file to the Highlevel Media Library. Use when you need to upload documents, images, or videos to store them in the media library for use in campaigns and other features. If hosted is true, fileUrl is required. Otherwise, file is required. Maximum file size: 25 MB for regular files, 500 MB for video files.