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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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-0…

Untrusted display-only summary

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

Untrusted display-only summary

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 si…

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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…

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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 (handl…

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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 in…

Untrusted display-only summary