Highlevel

Adds 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

Adds 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

Adds 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

Adds 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

Adds 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 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

Performs 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

Cancels 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

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

Checks 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

Completes 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

Performs 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

Creates 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

Creates 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

Creates 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

Creates 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

Creates 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

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

Creates 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

Creates 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

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

Creates 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

Creates 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

Creates 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

Creates 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

Creates 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

Creates 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

Creates 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

Creates 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

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

Creates 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

Creates 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

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.

Creates 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

Creates 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

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.

Creates 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

Creates 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

Creates 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

Creates 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

Creates 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

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

Creates 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

Deletes 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

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.

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

Deletes 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

Deletes 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

Deletes 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

Deletes 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

Deletes 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

Deletes 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

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

Deletes 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

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

Deletes 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

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

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

Deletes 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

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