HighLevel provides a marketing automation and CRM platform for agencies, featuring funnels, appointment scheduling, two-way texting, and other tools to drive client success
1Open Slashspace and go to Settings, then Connectors.
2On Discover, search for Highlevel and click Connect.
3Sign in to Highlevel in your browser. Slashspace updates when the account is connected.
Then ask for what you need in any Agent mode chat. Highlevel is on in every chat unless you switch it off.
What your chats can do
218 tools from Highlevel.
Add An Inbound MessageAdds an inbound message to a conversation in GoHighLevel. Use this action to record a message received from a contact (e.g. SMS, Email, WhatsApp) into an existing conversation. The conversationId, contactId, conversationProviderId, and message type are required. Required headers (handled automatically): Version: 2021-04-15
Add Contact TagsAdds one or more tags to an existing contact in a GoHighLevel sub-account. Use this action to label or segment a contact by attaching tags to it. The contactId identifies the contact, and tags is the list of tags to add. Required headers (handled automatically): Version: 2021-07-28
Add Followers ContactAdds one or more followers to an existing contact in a GoHighLevel sub-account. The contactId identifies the contact, and followers is the list of user IDs to add as followers. Required headers (handled automatically): Version: 2021-07-28
Add Followers OpportunityAdds one or more followers to an existing opportunity in a GoHighLevel sub-account. The id identifies the opportunity, and followers is the list of user IDs to add as followers. Required headers (handled automatically): Version: 2021-07-28
Add Remove Contact From BusinessAdds or removes a set of contacts from a business in a GoHighLevel sub-account in bulk. Provide the locationId, the list of contact ids, and the businessId to associate them with; pass a null businessId to remove the contacts from their business. Required headers (handled automatically): Version: 2021-07-28
Bulk EditBulk updates multiple products in a GoHighLevel sub-account. Use this action to edit several products at once by providing an array of product objects, each identified by its '_id'. The altId and altType identify the location the products belong to. Required headers (handled automatically): Version: 2021-07-28
Bulk UpdatePerforms a bulk update operation on products within a GoHighLevel sub-account. Supports updating price, availability, product collections, currency, or bulk deleting products for the specified product IDs or all products matching filters when selectAll is true. Required headers (handled automatically): Version: 2021-07-28
Cancel Scheduled MessageCancels a previously scheduled message in a GoHighLevel sub-account, identified by its messageId. This operation is destructive and prevents the scheduled message from being sent. Required headers (handled automatically): Version: 2021-04-15
Check Account FundsChecks 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
Check Url Slug ExistsChecks whether a given URL slug already exists for blog posts in a GoHighLevel sub-account. Use this action to validate slug uniqueness before creating or updating a blog post. Optionally exclude a specific post from the check by providing its post ID. Required headers (handled automatically): Version: 2021-07-28
Complete File UploadCompletes a previously initiated file upload for a GoHighLevel conversation message. Use this action after requesting an upload, passing the uploadId and filePath from that response to finalize the file and obtain its public URL. Required headers (handled automatically): Version: 2021-04-15
Bulk Update Contact TagsPerforms a bulk tag update on a list of GoHighLevel contacts. Use this action to add or remove tags across many contacts at once, with the operation type supplied as a path parameter. Required headers (handled automatically): Version: 2021-07-28
Create AppointmentCreates a new appointment (calendar event) in a GoHighLevel sub-account. Use this action to book a contact onto a calendar with a start time, optional end time, meeting location, and status. The calendarId, locationId, contactId, and startTime are required. Required headers (handled automatically): Version: 2021-04-15
Create Appointment NoteCreates a note for an existing appointment in a GoHighLevel sub-account. Use this action to attach a free-form note to a specific appointment identified by appointmentId. Required headers (handled automatically): Version: 2021-04-15
Create AssociationCreates a new association between two object types in a GoHighLevel sub-account. Use this action to define a relationship (such as linking a custom object to a contact) by specifying the labels and keys for both objects. Required headers (handled automatically): Version: 2021-07-28
Create Block SlotCreates a block slot on a GoHighLevel calendar to reserve time so it is unavailable for booking. Either calendarId or assignedUserId can be set, not both. Required headers (handled automatically): Version: 2021-04-15
Create Blog PostCreates a new blog post and adds it to an existing blog's post collection in a GoHighLevel sub-account. Use this action to publish or draft a blog post with its title, content, image, categories, author, and URL slug. The locationId and blogId identify the sub-account and the blog whose post set is modified. Required headers (handled automatically): Version: 2021-07-28
Create Brand VoiceCreates 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 CalendarCreates a new calendar in a GoHighLevel sub-account. Use this action to set up a booking calendar (round robin, event, class, collective, service, or personal) with its scheduling rules, availability, and team members. The locationId and name are required. Required headers (handled automatically): Version: 2021-04-15
Create Calendar GroupCreates a new calendar group in a GoHighLevel sub-account. Calendar groups organize related calendars under a shared name and slug. The locationId, name, description, and slug are required. Required headers (handled automatically): Version: 2021-04-15
Create Calendars Service LocationCreates 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 ContactCreates a new contact in a GoHighLevel sub-account. Use this action to add a person (lead or customer) with their name, contact details, tags, and custom fields. The locationId is required and identifies the sub-account the contact belongs to. Required headers (handled automatically): Version: 2021-07-28
Create Contact NoteCreates a new note for a specific contact in GoHighLevel. Use this action to attach a text note to a contact, optionally attributing it to a user and setting a title, color, or pinned state. The contactId identifies the contact the note belongs to. Required headers (handled automatically): Version: 2021-07-28
Create Contact TaskCreates a new task for a specific contact in GoHighLevel. Use this action to add a task (such as a follow-up or reminder) tied to a contact, with a title, due date, completion status, optional body text, and an optional assignee. Required headers (handled automatically): Version: 2021-07-28
Create ConversationCreates a new conversation in a GoHighLevel sub-account between the sub-account and a contact. Use this action to start a conversation thread for a given contact. Both the locationId and contactId are required. Required headers (handled automatically): Version: 2021-04-15
Create Custom FieldCreates a new custom field in a GoHighLevel sub-account (location). Custom fields let you capture additional structured data on records of a custom or standard object. Required headers (handled automatically): Version: 2021-07-28
Create Custom Field FolderCreates a new custom field folder for a custom object in a GoHighLevel sub-account. Use this action to group custom fields under a folder for the given objectKey and location. Required headers (handled automatically): Version: 2021-07-28
Create Custom Object SchemaCreates a new custom object schema in a GoHighLevel sub-account. Use this action to define a custom object with its display labels, internal key, primary display property, and the location it belongs to. Required headers (handled automatically): Version: 2021-07-28
Create Custom ValueCreates a new custom value within a GoHighLevel sub-account (location). Custom values act as reusable placeholders that can be referenced across the account. Provide the locationId, along with the name and value for the new custom value. Required headers (handled automatically): Version: 2021-07-28
Create Email Template FolderCreates 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 Event NotificationCreates one or more event notifications for a GoHighLevel calendar. Use this action to configure how and when participants are notified about calendar events (e.g. booking confirmations, reminders, follow-ups) across channels such as email, SMS, in-App and WhatsApp. The calendarId identifies the calendar. Required headers (handled automatically): Version: 2021-04-15
Create LinkCreates a new trigger link in a GoHighLevel sub-account. Use this action to add a trigger link with a name and a destination URL that contacts are redirected to when they click it. The locationId is required and identifies the sub-account the link belongs to. Required headers (handled automatically): Version: 2021-07-28
Create Media FolderCreates 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 Object RecordCreates a new record for a custom object schema in a GoHighLevel sub-account. Use this action to add an instance of a custom object (identified by its schemaKey) with its field values supplied via properties, and optionally assign owners and followers. Required headers (handled automatically): Version: 2021-07-28
Create OpportunityCreates a new opportunity in a GoHighLevel sub-account. Use this action to add an opportunity to a pipeline, associating it with a contact and a pipeline stage, and optionally setting its monetary value, assignee, and custom fields. Required headers (handled automatically): Version: 2021-07-28
Create ProductCreates 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 Product CollectionCreates a new product collection in a GoHighLevel sub-account. Use this action to group products under a named, navigable collection with an optional thumbnail image and SEO metadata. Required headers (handled automatically): Version: 2021-07-28
Create Product PriceCreates a new price for an existing product in a GoHighLevel sub-account. Use this action to attach pricing (one-time or recurring) to a product, specifying the amount, currency, and optional inventory, trial, and billing-cycle settings. The productId identifies the product and locationId identifies the sub-account. Required headers (handled automatically): Version: 2021-07-28
Create Recurring TaskCreates a recurring task within a GoHighLevel sub-account (location). Provide the task title and the recurrence rules (rruleOptions) that define how often the task repeats. Optionally associate contacts and assign owners. Required headers (handled automatically): Version: 2021-07-28
Create RelationCreates a relation between two records under a given association in a GoHighLevel sub-account. Use this action to link two entities (e.g. a contact and a custom object record) according to a previously defined association. Required headers (handled automatically): Version: 2021-07-28
Create ScheduleCreates a new calendar schedule in a GoHighLevel sub-account. A schedule defines the availability rules (intervals, days, dates) within a given timezone for a user and its associated calendars. Required headers (handled automatically): Version: 2021-04-15
Create TagCreates 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
Create TemplateCreates a new email template in a GoHighLevel sub-account. Use this action to add an email template (html, folder, import, builder, or blank) to a location. The locationId and type are required. importProvider is required only for import templates. Required headers (handled automatically): Version: 2021-07-28
Delete Appointment NoteDeletes a note associated with an appointment in a GoHighLevel sub-account. Identify the note by its appointmentId and noteId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-04-15
Delete AssociationDeletes 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 BusinessDeletes 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 CalendarDeletes a calendar from a GoHighLevel sub-account identified by its calendarId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-04-15
Delete ContactDeletes a contact from a GoHighLevel sub-account. Use this action to permanently remove a contact identified by its contactId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Delete ConversationDeletes a conversation from a GoHighLevel sub-account, identified by its conversationId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-04-15
Delete Custom FieldDeletes a custom field from a GoHighLevel location. Use this action to permanently remove a custom field identified by its id. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Delete Custom Field FolderDeletes a custom field folder from a GoHighLevel sub-account. Use this action to permanently remove a custom field folder identified by its id. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Delete Custom ValueDeletes a custom value from a GoHighLevel sub-account (location). Use this action to permanently remove a custom value identified by its id within the given locationId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Delete Email TemplateDeletes 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 EventDeletes a calendar event from a GoHighLevel sub-account. Use this action to permanently remove a calendar event identified by its eventId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-04-15
Delete Event NotificationDeletes 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 GroupDeletes a calendar group from a GoHighLevel sub-account, identified by its groupId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-04-15
Delete LinkDeletes 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 MediaDeletes 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 NoteDeletes a note associated with a specific contact in a GoHighLevel sub-account. Use this action to permanently remove a note identified by its id under the given contactId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Delete Object RecordDeletes 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 OpportunityDeletes an opportunity from a GoHighLevel sub-account. Use this action to permanently remove an opportunity identified by its opportunityId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Delete Price By Id For ProductDeletes a price identified by its priceId from a specific product in a GoHighLevel sub-account. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Delete Product By IdDeletes a product from a GoHighLevel sub-account. Use this action to permanently remove a product identified by its productId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Delete Product CollectionDeletes a product collection from a GoHighLevel sub-account. Use this action to permanently remove a product collection identified by its collectionId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Delete Product ReviewDeletes 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 Recurring TaskDeletes a recurring task from a GoHighLevel sub-account (location). Use this action to permanently remove a recurring task identified by its id within a specific location. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Delete RelationDeletes 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 ScheduleDeletes a calendar schedule from a GoHighLevel sub-account, identified by its id. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-04-15
Delete TagDeletes a tag from a GoHighLevel sub-account (location). Use this action to permanently remove a tag identified by its tagId within the given locationId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Delete TaskDeletes a task associated with a contact in a GoHighLevel sub-account. Use this action to permanently remove a task identified by its taskId from the given contact. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Delete TemplateDeletes an email builder template from a GoHighLevel sub-account. Use this action to permanently remove a template identified by its templateId within a given location. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Disable GroupEnables or disables a calendar group in a GoHighLevel sub-account. Set isActive to false to disable the group or true to enable it; the groupId identifies the group to update. Required headers (handled automatically): Version: 2021-04-15
Edit AppointmentEdits an existing appointment event in a GoHighLevel calendar. Use this action to update an appointment's time, status, location, assignment, and other details. The eventId identifies the appointment to edit; only the fields you provide are changed. Required headers (handled automatically): Version: 2021-04-15
Edit Block SlotUpdates an existing block slot event on a GoHighLevel calendar. Use this action to modify the title, calendar/assigned user, location, and start/end times of a block slot identified by eventId. Required headers (handled automatically): Version: 2021-04-15
Edit GroupEdits an existing calendar group in a GoHighLevel sub-account. Use this action to update a group's name, description, and slug. The groupId identifies the calendar group to update. Required headers (handled automatically): Version: 2021-04-15
Export Messages By LocationExports messages for a specific GoHighLevel sub-account (location). Use this action to retrieve a paginated list of messages, optionally filtered by conversation, contact, channel, and date range, sorted by creation or update time. Required headers (handled automatically): Version: 2021-04-15
Fetch Calendar ResourcesRetrieves a paginated list of calendar resources (equipments or rooms) for a specific sub-account in GoHighLevel. Use this action to explore the resources available for calendar scheduling, such as meeting rooms or equipment. Required headers (handled automatically): Version: 2021-04-15
Fetch CampaignsRetrieves a list of email campaigns (schedules) for a specific GoHighLevel sub-account. Use this action to fetch and explore campaign information, with support for filtering by status, email status, name, and parent, as well as pagination via limit and offset. Required headers (handled automatically): Version: 2021-07-28
Fetch Email TemplatesFetches 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
Fetch Redirects ListRetrieves a paginated list of URL redirects configured for a specific GoHighLevel sub-account (location). Use this action to explore, search, and paginate through the redirects set up under a location's funnels. Required headers (handled automatically): Version: 2021-07-28
Find AssociationsRetrieves 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 NumberGenerates 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 Blog Authors By LocationRetrieves a paginated list of blog authors for a specific GoHighLevel sub-account (location). Use this action to fetch the available blog authors when managing or displaying blog content. Required headers (handled automatically): Version: 2021-07-28
Get All Categories By LocationRetrieves a paginated list of blog categories for a specific GoHighLevel sub-account (location). Use this action to fetch and explore the blog categories configured for a location, such as to display available categories or paginate through them. Required headers (handled automatically): Version: 2021-07-28
Get All NotesRetrieves 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 Or Email Sms TemplatesRetrieves all templates (or email/SMS/WhatsApp templates filtered by type) for a specific GoHighLevel sub-account (location). Use this action to list available message templates, optionally filtering by template type and paginating through the results. Required headers (handled automatically): Version: 2021-07-28
Get All SchedulesRetrieves all schedules for a given user within a sub-account (location), optionally filtered by calendar. Use this action to list the working/availability schedules configured for a user. Supports pagination via the skip and limit query parameters. Required headers (handled automatically): Version: 2021-04-15
Get All TasksRetrieves 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 Appointments For ContactRetrieves all appointments associated with a specific contact in a GoHighLevel sub-account. Use this action to list the events booked for a contact, including their calendar, status, timing, and assignment details. Required headers (handled automatically): Version: 2021-07-28
Get Association By IdRetrieves a single association from GoHighLevel by its unique identifier. Use this action to fetch the full details of an association, including the objects it links and its association type. Required headers (handled automatically): Version: 2021-07-28
Get Association By Object KeysRetrieves associations from a GoHighLevel sub-account by object key. Use this action to fetch association details, including the first and second object labels, keys, and the association type. Required headers (handled automatically): Version: 2021-07-28
Get Blocked SlotsRetrieves blocked slots for a GoHighLevel sub-account within a given time range. Use this action to fetch calendar blocked slots, optionally filtered by user, calendar, or group. Required headers (handled automatically): Version: 2021-04-15
Get BlogsRetrieves 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 BoardsRetrieves 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 VoiceRetrieves 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 CalendarRetrieves 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 Calendar EventsRetrieves calendar events for a GoHighLevel sub-account within a given time range. Use this action to fetch appointments and events, optionally filtered by user, calendar, or calendar group. Required headers (handled automatically): Version: 2021-04-15
Get CalendarsRetrieves 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 Event Calendar ScheduleRetrieves 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 BookingsRetrieves 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 ContactRetrieves a single contact from a GoHighLevel sub-account by its unique identifier. Use this action to fetch the full details of a contact, including their name, contact information, tags, and custom fields. Required headers (handled automatically): Version: 2021-07-28
Get Contacts By Business IdRetrieves a paginated list of contacts associated with a specific business in a GoHighLevel sub-account. Use this action to fetch contacts filtered by business identifier, optionally narrowing the results with a search query and paginating via limit and skip parameters. Required headers (handled automatically): Version: 2021-07-28
Get ConversationRetrieves 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 MessagesRetrieves 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 FieldRetrieves a single custom field from a GoHighLevel sub-account (location) by its unique identifier. Use this action to fetch the full details of a custom field, including its name, key, data type, and available options. Required headers (handled automatically): Version: 2021-07-28
Get Custom Field By IdRetrieves a single custom field from a GoHighLevel sub-account by its unique identifier. Use this action to fetch the full details of a custom field, including its name, data type, options, and configuration. Required headers (handled automatically): Version: 2021-07-28
Get Custom FieldsRetrieves the custom fields configured for a specific GoHighLevel sub-account (location). Use this action to list all custom fields, optionally filtering by model (contact, opportunity, or all). Required headers (handled automatically): Version: 2021-07-28
Get Custom Fields By Object KeyRetrieves all custom fields and custom field folders for a given object within a GoHighLevel sub-account, identified by the object key (e.g. 'contact', 'opportunity', or a custom object key). Required headers (handled automatically): Version: 2021-07-28
Get Custom ValueRetrieves a single custom value from a GoHighLevel sub-account (location) by its unique identifier. Use this action to fetch the details of a custom value, including its name, field key, and value. Required headers (handled automatically): Version: 2021-07-28
Get Custom ValuesRetrieves 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 Email By IdRetrieves a single email message from a GoHighLevel sub-account by its unique identifier. Use this action to fetch the full details of an email, including its subject, body, sender, recipients, and delivery status. Required headers (handled automatically): Version: 2021-07-28
Get Bulk Action CampaignsRetrieves 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 CampaignsRetrieves 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 TemplatesRetrieves 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 NotificationRetrieves 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 PageRetrieves 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 CountRetrieves 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 GroupsRetrieves the list of calendar groups for a specific GoHighLevel sub-account (location). Use this action to fetch and explore calendar group information, such as group name, description, slug, and active status. Required headers (handled automatically): Version: 2021-04-15
Get Invoice SettingsRetrieves 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 SchedulesRetrieves 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 Link By IdRetrieves a single trigger link from a GoHighLevel sub-account by its unique identifier. Use this action to fetch the details of a link, including its name, redirect URL, and field key. Required headers (handled automatically): Version: 2021-07-28
Get LinksRetrieves all trigger links for a specific GoHighLevel sub-account (location). Use this action to fetch the list of links, including their names, redirect targets, and field keys. Required headers (handled automatically): Version: 2021-07-28
Get List InventoryRetrieves a paginated list of inventory items for a specific location. Use this action to fetch inventory data such as available quantities, SKUs, and product associations from GoHighLevel. Supports filtering by search query and pagination using limit and offset parameters. Required headers (handled automatically): Version: 2021-07-28
Get LocationRetrieves a single sub-account (location) from GoHighLevel by its unique identifier. Use this action to fetch the full details of a location, including its name, address, contact information, and timezone. Required headers (handled automatically): Version: 2021-07-28
Get Lost ReasonRetrieves the list of opportunity lost reasons configured for a GoHighLevel sub-account. Use this action to fetch and filter lost reasons by name or search query, with support for pagination and optionally including deleted reasons and a total count. Required headers (handled automatically): Version: 2021-07-28
List Media FilesFetches 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 MessageRetrieves a single message from a GoHighLevel conversation by its unique identifier. Use this action to fetch the full details of a message, including its body, type, direction, status, and attachments. Required headers (handled automatically): Version: 2021-04-15
Get NoteRetrieves a single note for a specific contact in a GoHighLevel sub-account by its unique identifier. Use this action to fetch the full details of a note, including its body, title, and metadata. Required headers (handled automatically): Version: 2021-07-28
Get Object By Location IdRetrieves the list of custom and standard object schemas for a specific GoHighLevel sub-account (location). Use this action to discover the available objects, their keys, labels, and metadata configured for a location. Required headers (handled automatically): Version: 2021-07-28
Get Object SchemaRetrieves 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 IdRetrieves 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 OpportunityRetrieves a single opportunity from a GoHighLevel sub-account by its unique identifier. Use this action to fetch the full details of an opportunity, including its name, monetary value, pipeline, stage, status, and associated contact. Required headers (handled automatically): Version: 2021-07-28
Get PipelinesRetrieves 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 PostsRetrieves 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
Get Price By Id For ProductRetrieves a single price for a specific product in a GoHighLevel sub-account by its unique identifier. Use this action to fetch the full details of a product price, including its amount, currency, type, and inventory settings. Required headers (handled automatically): Version: 2021-07-28
Get Product By IdRetrieves a single product from a GoHighLevel sub-account by its unique identifier. Use this action to fetch the full details of a product, including its name, type, variants, taxes, and label information. Required headers (handled automatically): Version: 2021-07-28
Get Product Collection IdRetrieves a single product collection from a GoHighLevel sub-account by its unique identifier. Use this action to fetch the full details of a product collection. Required headers (handled automatically): Version: 2021-07-28
Get Product ReviewsRetrieves a paginated list of product reviews for a specific sub-account (location) in GoHighLevel. Use this action to fetch and explore product reviews, optionally filtered by product, store, rating, or date range, and sorted by creation date or rating. Required headers (handled automatically): Version: 2021-07-28
List ProductsRetrieves 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 PricesLists 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 Product Store StatsRetrieves product statistics for a specific store in a GoHighLevel sub-account, including the total number of products, the number included in the store, and the number excluded from the store. Supports filtering by search term and collection ids. Required headers (handled automatically): Version: 2021-07-28
Get Recurring Task By IdRetrieves a single recurring task from a GoHighLevel sub-account by its unique identifier. Use this action to fetch the full details of a recurring task, including its title, description, recurrence rule, and assignment. Required headers (handled automatically): Version: 2021-07-28
Get Relations By Record IdRetrieves 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 Reviews CountRetrieves the count of reviews for a specific location in GoHighLevel, optionally filtered by rating, date range, product, or store. Use this action to obtain aggregated review status counts for reporting and analytics. Required headers (handled automatically): Version: 2021-07-28
Get Schedule By IdRetrieves a single calendar schedule from a GoHighLevel sub-account by its unique identifier. Use this action to fetch the full details of a schedule, including its availability rules, timezone, and linked calendars. Required headers (handled automatically): Version: 2021-04-15
Get SlotsRetrieves the available free time slots for a specific GoHighLevel calendar within a given date range. Use this action to determine when appointments can be booked, optionally filtered by timezone and by specific user(s). The response is a mapping keyed by date, where each entry contains the list of free slot timestamps for that date. Required headers (handled automatically): Version: 2021-04-15
Get Store SettingsRetrieves 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 TagRetrieves a single tag from a GoHighLevel sub-account by its unique identifier. Use this action to fetch the details of a tag, including its name and the location it belongs to. Required headers (handled automatically): Version: 2021-07-28
Get TaskRetrieves a single task for a specific contact in a GoHighLevel sub-account by its unique identifier. Use this action to fetch the full details of a task, including its title, body, assignee, due date, and completion status. Required headers (handled automatically): Version: 2021-07-28
Get TimezonesRetrieves 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 LocationRetrieves 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
Initiate File UploadInitiates a direct file upload for a GoHighLevel conversation message by requesting a signed GCS upload URL. Use the returned uploadUrl to PUT the file content, then complete the upload via the confirmation endpoint. Required headers (handled automatically): Version: 2021-04-15
List Agent Studio AgentsLists 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 VoicesRetrieves 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 Event NotificationsRetrieves the event notifications configured for a specific GoHighLevel calendar. Use this action to list how and when notifications are sent for calendar events, optionally filtering by active or deleted status and paginating the results. Required headers (handled automatically): Version: 2021-04-15
List Funnels FunnelRetrieves 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 CouponsRetrieves 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 Product CollectionsRetrieves a paginated list of product collections for a specific location (sub-account) in GoHighLevel. Use this action to browse or filter product collections by name or by specific collection ids. Required headers (handled automatically): Version: 2021-07-28
List TagsRetrieves the list of tags defined in a GoHighLevel sub-account (location). Use this action to fetch all tags available for a given location, including each tag's id, name, and location identifier. Required headers (handled automatically): Version: 2021-07-28
Locations Create Custom FieldCreates a new custom field within a GoHighLevel sub-account (location). Use this action to define a custom field for contacts or opportunities, specifying its name, data type, and other display options. Required headers (handled automatically): Version: 2021-07-28
Locations Delete Custom FieldDeletes a custom field from a GoHighLevel location (sub-account). Use this action to permanently remove a custom field identified by its id within the specified locationId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28
Locations Update Custom FieldUpdates an existing custom field in a GoHighLevel sub-account (location). Use this action to modify a custom field's name, placeholder, position, accepted formats, and other attributes. The locationId and id together identify the custom field to update. Required headers (handled automatically): Version: 2021-07-28
Put LocationUpdates an existing sub-account/location in GoHighLevel. Use this action to modify a location's business details, settings, social links, and integration credentials. The locationId identifies the location to update. Required headers (handled automatically): Version: 2021-07-28
Remove Contact From Every CampaignRemoves 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
Remove Contact TagsRemoves one or more tags from a contact in a GoHighLevel sub-account. Use this action to detach existing tags from a contact identified by its contactId. The tags to remove are provided in the request body. Required headers (handled automatically): Version: 2021-07-28
Remove Followers ContactRemoves one or more followers from a contact in a GoHighLevel sub-account. Provide the contactId and a list of follower user IDs to remove. Required headers (handled automatically): Version: 2021-07-28
Remove Followers OpportunityRemoves one or more followers from an existing opportunity in a GoHighLevel sub-account. Provide the opportunity id and the list of follower user IDs to remove, or set isRemoveAllFollowers to true to remove all followers. Required headers (handled automatically): Version: 2021-07-28
Search ContactsSearches for contacts in a GoHighLevel sub-account using advanced filters, sorting, and pagination. Use this action to find contacts matching specific criteria within a location. The locationId is required and identifies the sub-account to search. Required headers (handled automatically): Version: 2021-07-28
Search Conversation AI AgentsSearches 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 full-text search across agent names and descriptions. The target location is derived from the authenticated token. Results can be capped with the limit parameter. Required headers (handled automatically): Version: 2021-07-28
Search ConversationsReturns 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 ContactSearches 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 LinksSearches 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
Search LocationsSearches for sub-accounts (locations) within a GoHighLevel agency. Use this action to look up locations belonging to a company, optionally filtering by email and paginating through the results using skip and limit. Required headers (handled automatically): Version: 2021-07-28
Search Object RecordsSearches records of a custom object in a GoHighLevel sub-account. Use this action to find records of a given object schema by querying its searchable properties. The schemaKey identifies the object, locationId identifies the sub-account, and query drives the search. Required headers (handled automatically): Version: 2021-07-28
Search OpportunitiesSearches for opportunities within a GoHighLevel sub-account. Use this action to find and filter opportunities by pipeline, stage, contact, assigned user, status, date, and more. The location_id is required and identifies the sub-account to search. Required headers (handled automatically): Version: 2021-07-28
Search Opportunities AdvancedPerforms an advanced search for opportunities within a GoHighLevel sub-account. Use this action to query opportunities with pagination and optionally include related entities such as notes, tasks, calendar events, and unread conversations for each result. Required headers (handled automatically): Version: 2021-07-28
Search UsersSearches users in a HighLevel company and location. Use this action to harvest user IDs for assignment, follower, schedule, and calendar-resource workflows. Required headers (handled automatically): Version: 2021-07-28
Send MessageSends a message to a contact in a GoHighLevel sub-account across a channel (SMS, RCS, Email, WhatsApp, Instagram, or Facebook). Use this action to deliver outbound messages, schedule them, or reply within an existing conversation thread. The message type and contactId are required. Required headers (handled automatically): Version: 2021-04-15
Set Default Brand VoiceSets 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.
Task SearchSearches tasks within a GoHighLevel sub-account (location). Use this action to find tasks filtered by contact, assigned user, completion status, a free-text query, or business, with pagination support via limit and skip. The locationId is required and identifies the sub-account to search within. Required headers (handled automatically): Version: 2021-07-28
Update AssociationUpdates 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 BusinessUpdates 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 CalendarUpdates 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 ScheduleUpdates 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 ScheduleUpdates 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 ContactUpdates an existing contact in a GoHighLevel sub-account. Use this action to modify a contact's name, contact details, tags, and custom fields. The contactId identifies the contact to update; only the fields you provide are changed. Required headers (handled automatically): Version: 2021-07-28
Update Contact TaskUpdates a task associated with a contact in GoHighLevel. Use this action to modify an existing task's title, body, due date, completion status, or assignee. Both the contactId and taskId identify the task to update. Required headers (handled automatically): Version: 2021-07-28, Content-Type: application/json
Update ConversationUpdates 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 Custom FieldUpdates an existing custom field in a GoHighLevel location. Use this action to modify a custom field's name, description, placeholder, options, and display settings. Required headers (handled automatically): Version: 2021-07-28
Update Custom Field FolderUpdates an existing custom field folder in a GoHighLevel sub-account. The id identifies the folder to update; provide the folder name and location id. Required headers (handled automatically): Version: 2021-07-28
Update Custom ObjectUpdates an existing custom object schema in a GoHighLevel sub-account. Use this action to modify the object's labels, description, and searchable properties. The key identifies the custom object schema to update. Required headers (handled automatically): Version: 2021-07-28
Update Custom ValueUpdates an existing custom value within a GoHighLevel sub-account (location). Provide the locationId and the custom value id to identify the record, along with the new name and value. Required headers (handled automatically): Version: 2021-07-28
Update Display PriorityUpdates the display priority (ordering) of products within a GoHighLevel store. Provide the storeId along with the location context and the list of products with their display priorities. Required headers (handled automatically): Version: 2021-07-28
Update Email TemplateUpdates 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 InventoryUpdates the inventory for one or more prices in a GoHighLevel sub-account. Provide the altId/altType identifying the location and a list of items, each referencing a priceId along with its available quantity and out-of-stock purchase settings. Required headers (handled automatically): Version: 2021-07-28
Update LinkUpdates an existing trigger link in a GoHighLevel sub-account. Use this action to change the link's name or redirect destination. The linkId identifies the link to update. Required headers (handled automatically): Version: 2021-07-28
Bulk Delete Media FilesBulk 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 FilesUpdates 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 NoteUpdates an existing note attached to a contact in a GoHighLevel sub-account. Use this action to modify the note's body, title, color, or pinned status. The contactId and id identify the note to update; only the fields you provide are changed. Required headers (handled automatically): Version: 2021-07-28
Update Object RecordUpdates an existing record of a custom object (or standard object) in a GoHighLevel sub-account. Identify the record by its schemaKey and id, and provide the locationId of the owning sub-account along with the fields to change. Required headers (handled automatically): Version: 2021-07-28
Update OpportunityUpdates an existing opportunity in a GoHighLevel sub-account. Use this action to modify an opportunity's name, pipeline, stage, status, monetary value, assignee, and custom fields. The opportunityId identifies the opportunity to update; only the fields you provide are changed. Required headers (handled automatically): Version: 2021-07-28
Update Opportunity StatusUpdates the status of an existing opportunity in a GoHighLevel sub-account. Use this action to move an opportunity to open, won, lost, or abandoned. The opportunityId identifies the opportunity to update; a lostReasonId may be supplied when marking an opportunity as lost. Required headers (handled automatically): Version: 2021-07-28
Update Price By Id For ProductUpdates an existing price for a product in a GoHighLevel sub-account. Use this action to modify a price's name, type, currency, amount, recurring details, inventory settings, and other attributes. The productId and priceId identify the price to update. Required headers (handled automatically): Version: 2021-07-28
Update Product By IdUpdates an existing product in a GoHighLevel sub-account by its productId. Use this action to modify a product's name, type, description, media, variants, pricing references, taxes, and other attributes. Required headers (handled automatically): Version: 2021-07-28
Update Product CollectionUpdates an existing product collection in a GoHighLevel sub-account. The collectionId identifies the collection to update; only the fields you provide are changed. Required headers (handled automatically): Version: 2021-07-28
Update Product ReviewUpdates 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 Recurring TaskUpdates an existing recurring task for a GoHighLevel sub-account (location). Use this action to modify a recurring task's title, description, assigned contacts/owners, and recurrence rules. The locationId and id identify the task to update. Required headers (handled automatically): Version: 2021-07-28
Update Store StatusIncludes or excludes products from a GoHighLevel store. Provide the storeId along with the action ('include' or 'exclude') and the list of product IDs to update their association with the store. Required headers (handled automatically): Version: 2021-07-28
Update TagUpdates 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 CompletedUpdates 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 TemplateUpdates an existing email builder template in a GoHighLevel sub-account. Supply the template's drag-and-drop builder data, HTML content, and editor type to modify it. Required headers (handled automatically): Version: 2021-07-28
Upload File AttachmentsUploads file attachments to a GoHighLevel conversation. Provide the conversationId, contactId, locationId, and a list of attachmentUrls to upload. Optionally supports group SMS uploads via chatServiceSid and isGroupSms. Required headers (handled automatically): Version: 2021-04-15
Upload File to Custom FieldsUpload 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 FileUpload 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.
Upsert ContactCreates or updates a contact in a GoHighLevel sub-account. If a duplicate contact is found (based on the location's duplicate settings), it is updated; otherwise a new contact is created. The locationId is required and identifies the sub-account. Required headers (handled automatically): Version: 2021-07-28
Upsert OpportunityCreates or updates an opportunity in a GoHighLevel sub-account. If an opportunity id is provided, the existing opportunity is updated; otherwise a new opportunity is created. The pipelineId and locationId are required. Required headers (handled automatically): Version: 2021-07-28
Validate Groups SlugValidates whether a calendar group slug is available within a GoHighLevel sub-account (location). Use this action before creating or updating a calendar group to confirm the desired slug is not already in use. Required headers (handled automatically): Version: 2021-04-15
