- Category: crm
- Auth: OAUTH2, BEARER_TOKEN
- Composio-managed OAuth available? No
- Tools: 555
- Triggers: 0
- Slug:
HIGHLEVEL_LOCATION - Version: 20261101_00
Tools
Add custom audience member
Add custom audience member
Batch update audience members
Batch update audience members
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_BATCH_UPDATE_AUDIENCE_MEMBERSQueue an asynchronous job to add, remove, or replace Facebook custom-audience members via CSV or smart lists. HighLevel does not validate the audience or smart-list IDs before returning success:true, so that response means only that the job was accepted, not that members changed. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Create conversation form
Create conversation form
Create page lead form
Create page lead form
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_CREATE_PAGE_LEAD_FORMCreate a new lead form on a Facebook page. is_draft=true always creates a new local draft; draft_form_id does not update an existing draft, and drafts cannot be deleted through this toolkit. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
isDraft is false or omitted; optional for drafts.Output
Delete ad
Delete ad
Delete ad set
Delete ad set
Delete campaign
Delete campaign
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_DELETE_CAMPAIGNArchive a Facebook campaign and its ad sets. This is a soft delete: Get campaign continues to return the campaign with publishingStatus=ARCHIVED, and repeated deletes may still return success=true. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Delete custom audience
Delete custom audience
Delete Facebook integration
Delete Facebook integration
Delete page connection
Delete page connection
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_DELETE_PAGERemove a Facebook page connection from a location. HighLevel does not validate page_id before returning success=true, so success confirms request acceptance, not that the page existed or was disconnected. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Duplicate ad
Duplicate ad
Duplicate ad set
Duplicate ad set
Duplicate campaign
Duplicate campaign
Get campaign with linked entities
Get campaign with linked entities
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_GET_CAMPAIGNRetrieve a Facebook campaign with its linked adsets and ads Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
Output
Get Facebook Campaign Publishing Progress
Get Facebook Campaign Publishing Progress
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_GET_CAMPAIGN_PUBLISHING_PROGRESSReturn the current Meta publishing step counts and completion state for a Facebook campaign. Location PITs must be provisioned with the HighLevel permission adPublishing.readonly; a minimal PIT without it was denied while a broad PIT passed.Input Parameters
Output
Get conversation forms
Get conversation forms
Get custom audience by ID
Get custom audience by ID
Get custom audiences
Get custom audiences
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_GET_CUSTOM_AUDIENCESRetrieve Facebook custom audiences for a location. HighLevel returns an empty details list for an unknown ad account ID, so an empty result does not validate that account. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
Output
Get entities
Get entities
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_GET_ENTITYList Facebook campaigns, ad sets, or ads that exist on Meta. Local HighLevel drafts are not returned. type=INTEGRATION requires selected_ad_account_id. An empty result is returned as data=[] rather than an error. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
Output
Get Instagram accounts for page
Get Instagram accounts for page
Get lead form by ID
Get lead form by ID
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_GET_LEAD_FORMRetrieve a specific published or draft Facebook lead form by ID. Draft IDs require is_draft=true. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
Output
Get page lead forms
Get page lead forms
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_GET_PAGE_LEAD_FORMSRetrieve lead forms for a Facebook page. Draft IDs are returned with a draft_ prefix; pass that ID and is_draft=true to Get lead form by ID. HighLevel may return drafts even when is_draft=false. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
Output
Get Facebook pages
Get Facebook pages
Get conversion pixels
Get conversion pixels
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_GET_PIXELSRetrieve Facebook conversion pixels for a location. Facebook-channel results are returned under items; Instagram-channel results are returned under details. HighLevel may return the full pixel list when page_id does not match a known page, so an unfiltered result does not confirm that page exists. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
Output
Pause ad
Pause ad
Pause ad set
Pause ad set
Pause campaign
Pause campaign
Publish campaign
Publish campaign
Remove custom audience member
Remove custom audience member
Resume ad
Resume ad
Resume ad set
Resume ad set
Resume campaign
Resume campaign
Set default page
Set default page
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_SET_DEFAULT_PAGESet the default Facebook page for a location. HighLevel does not validate page_id before returning success=true and an unknown ID can unset the real default, so verify the integration after this call. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Update custom audience
Update custom audience
Upsert ad
Upsert ad
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_UPSERT_ADCreate or update a Facebook ad. Creating requires a non-empty name. Each media item type must be lowercase image or video. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Upsert adset
Upsert adset
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_UPSERT_ADSETCreate or update a Facebook ad set. Creating requires a non-empty name. Publishing every ad set requires name, pageId, audience, and budget with budgetType and amount. audience.placements must be an object keyed by platform, for example {facebook: [feed], instagram: [stream]}, not a string array. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Upsert campaign
Upsert campaign
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_UPSERT_CAMPAIGNCreate or update a Facebook campaign. Creating requires a non-empty name and an objective; updates may identify the campaign by id. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Upsert conversion pixel
Upsert conversion pixel
HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_UPSERT_PIXELCreate or update a Facebook conversion pixel; omitting conversion_pixel_id or supplying an unknown ID creates a real Meta pixel/dataset, not a local draft. INSTAGRAM_DM pixels cannot be updated, a supplied name must be nonblank, and Location PITs need adPublishing.write.Input Parameters
Output
Create offline user list job
Create offline user list job
HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_CREATE_OFFLINE_USER_LIST_JOBCreate a job to upload users to an existing Google Customer Match list. Verify user_list_id and smart_list_ids before calling: HighLevel can return success=true even when either identifier does not exist, and this action cannot verify downstream ingestion. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Delete conversion
Delete conversion
HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_DELETE_CONVERSIONSoft-delete a Google Ads conversion action by ID. Google retains the resource with status REMOVED, so GET_CONVERSION_BY_ID may still return it after deletion. HighLevel may report an unknown ID as an opaque 500 rather than not-found. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Delete segment
Delete segment
Get assets
Get assets
Get audience by ID
Get audience by ID
Get audiences
Get audiences
Get Google Campaign by ID
Get Google Campaign by ID
Get conversion by ID
Get conversion by ID
Get conversion goals
Get conversion goals
Get conversions
Get conversions
HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_GET_CONVERSIONSRetrieve Google Ads conversion actions for a location Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
Output
Get entities
Get entities
HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_GET_ENTITYRetrieve Google-side campaigns, ad groups, or ads through the current AD_MANAGER path. HighLevel draft campaigns are not returned; retain the ID returned by UPSERT_CAMPAIGN and use GET_CAMPAIGN_BY_ID to read a draft. ADGROUP requires campaign_id, while AD requires ad_group_id or campaign_id. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
Output
Get keyword ideas
Get keyword ideas
HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_GET_KEYWORD_IDEASRetrieve keyword suggestions for Google Ads campaigns Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
Output
Get segment by ID
Get segment by ID
Get segments
Get segments
Get target interests
Get target interests
HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_GET_TARGET_INTERESTSRetrieve affinity and in-market audience options for Google Ads targeting. IN_MARKET with SEARCH or DISPLAY exceeds the platform response-size limit (413); use another supported channel when possible. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
Output
Publish ad
Publish ad
Upsert assets
Upsert assets
HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_UPSERT_ASSETSCreate or update Google Ads creative assets. Include resourceName to update an existing CALL or SITELINK asset. On SITELINK updates, resend description1 and description2 because HighLevel clears either omitted description. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Upsert audience
Upsert audience
HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_UPSERT_AUDIENCECreate or update a Google Ads combined audience. dimensions is required; a minimal live-proven value is {“genders”:[“FEMALE”]}. HighLevel exposes no delete endpoint for these audiences. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Upsert Google campaign
Upsert Google campaign
HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_UPSERT_CAMPAIGNCreate or update a full Google Ads campaign structure. HighLevel exposes no campaign delete endpoint; archive a draft by updating it with publishing_status=ARCHIVED. GET_ENTITY only lists Google-side entities and will not find HighLevel drafts, so retain the returned HighLevel id for GET_CAMPAIGN_BY_ID. HighLevel currently does not persist maximum_cpc or advanced_options. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Upsert conversion
Upsert conversion
HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_UPSERT_CONVERSIONCreate or update a Google Ads conversion action. On create, Google may replace GOOGLE_ADS_LAST_CLICK with GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN; read the action back before relying on the attribution model. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Upsert segment
Upsert segment
HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_UPSERT_SEGMENTCreate or update a Google Ads audience segment Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Create lead form
Create lead form
HIGHLEVEL_LOCATION_AD_PUBLISHING_LI_CREATE_LEAD_FORMCreate a new LinkedIn lead gen form for an ad account Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
Output
Get ad campaign group
Get ad campaign group
Get campaign group reporting
Get campaign group reporting
HIGHLEVEL_LOCATION_AD_PUBLISHING_LI_GET_CAMPAIGN_GROUP_REPORTINGRetrieve reporting metrics for a specific LinkedIn campaign group Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
Output
Get lead forms
Get lead forms
Publish ad campaign group
Publish ad campaign group
Update ad status
Update ad status
Upsert ad campaign group
Upsert ad campaign group
HIGHLEVEL_LOCATION_AD_PUBLISHING_LI_UPSERT_CAMPAIGN_GROUPCreate or update a LinkedIn ad campaign group with campaigns and ads Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
id when updating an existing group; it is distinct from LinkedIn’s numeric adCampaignGroupId.id.Output
Get Affiliate
Get Affiliate
List Affiliates
List Affiliates
List Commissions
List Commissions
List Payouts
List Payouts
Create Agent
Create Agent
Delete Agent
Delete Agent
Execute Agent
Execute Agent
HIGHLEVEL_LOCATION_AGENT_STUDIO_EXECUTE_AGENTExecute an active Agent Studio agent and return its complete non-streaming response. Execution may invoke the agent’s configured actions and cause external side effects. Location PITs must be provisioned with the HighLevel permission: agent-studio.write.Input Parameters
Output
Get Agent
Get Agent
List Agents
List Agents
Promote to Production
Promote to Production
Update Agent Metadata
Update Agent Metadata
Update Agent
Update Agent
HIGHLEVEL_LOCATION_AGENT_STUDIO_UPDATE_AGENT_VERSIONUpdate a specific Agent Studio version. HighLevel’s PATCH currently replaces nodes, edges, and variables with empty shells; set graphs at create time and update only version_name, description, or global_config here. Location PITs must be provisioned with the HighLevel permission: agent-studio.write.Input Parameters
Output
Create association
Create association
Create relation
Create relation
HIGHLEVEL_LOCATION_ASSOCIATIONS_CREATE_RELATIONCreate a relation between two records in the association definition’s canonical first-object then second-object order; reversing the records is invalid. Location PITs must be provisioned with the HighLevel permission: associations/relation.write.Input Parameters
Output
Delete association
Delete association
HIGHLEVEL_LOCATION_ASSOCIATIONS_DELETE_ASSOCIATIONPermanently delete a user-defined association. HighLevel refuses deletion while relations remain; first list them with GET_RELATIONS_BY_RECORD_ID and remove each with DELETE_RELATION. Location PITs must be provisioned with the HighLevel permission: associations.write.Input Parameters
Output
Delete relation
Delete relation
List associations
List associations
Get association by ID
Get association by ID
Get associations by object key
Get associations by object key
Get association by key name
Get association by key name
Get relations by record ID
Get relations by record ID
HIGHLEVEL_LOCATION_ASSOCIATIONS_GET_RELATIONS_BY_RECORD_IDReturn a page of relations for a record, optionally filtered by association IDs. Results can include HighLevel system-defined opportunity/contact relations as well as user-defined relations. Location PITs must be provisioned with the HighLevel permission: associations/relation.readonly.Input Parameters
Output
Update association
Update association
Check blog URL slug
Check blog URL slug
Create blog post
Create blog post
List blog categories
List blog categories
List blog posts
List blog posts
List blogs
List blogs
Update blog post
Update blog post
Create a new brand board
Create a new brand board
Create Brand Voice
Create Brand Voice
Delete a Brand Board
Delete a Brand Board
Delete Brand Voice
Delete Brand Voice
Get Brand Board
Get Brand Board
Get Brand Boards
Get Brand Boards
Get Brand Voice
Get Brand Voice
List Brand Voices
List Brand Voices
Set Default Brand Voice
Set Default Brand Voice
Update a Brand Board
Update a Brand Board
Update Brand Voice
Update Brand Voice
Create Business
Create Business
Delete Business
Delete Business
Get Business
Get Business
Get Businesses by Location
Get Businesses by Location
Update Business
Update Business
Apply user availability schedule to a calendar
Apply user availability schedule to a calendar
Create appointment
Create appointment
HIGHLEVEL_LOCATION_CALENDARS_CREATE_APPOINTMENTCreate an appointment. Recurring appointments and calls with ignore_free_slot_validation require assigned_user_id. Location PITs must be provisioned with the HighLevel permission: calendars/events.write.Input Parameters
calendar.locationConfigurationsor calendar.teamMembers[].locationConfigurationsaddress is provided in the request body, the meetingLocationType defaults to custom.meetingLocationId is provided - true - If only meetingLocationType is providedOutput
Create Note
Create Note
HIGHLEVEL_LOCATION_CALENDARS_CREATE_APPOINTMENT_NOTECreate an appointment note. HighLevel can store the note and then return an error for an invalid user_id, so use a verified user ID or omit it rather than retrying blindly. Location PITs must be provisioned with the HighLevel permission: calendars/events.write.Input Parameters
Output
Create Block Slot
Create Block Slot
Create Calendar
Create Calendar
HIGHLEVEL_LOCATION_CALENDARS_CREATE_CALENDARCreate calendar in a location. Location PITs must be provisioned with the HighLevel permission: calendars.write.Input Parameters
locationConfigurations.location or teamMembers[].locationConfigurations.location instead.Output
Create Calendar Group
Create Calendar Group
Create Calendar Resource
Create Calendar Resource
HIGHLEVEL_LOCATION_CALENDARS_CREATE_CALENDAR_RESOURCECreate calendar resource by resource type (Services V1) Location PITs must be provisioned with the HighLevel permission: calendars/resources.write.Input Parameters
Output
Create event calendar availability schedule
Create event calendar availability schedule
HIGHLEVEL_LOCATION_CALENDARS_CREATE_CALENDAR_SCHEDULECreate or replace the availability schedule for an event calendar. This endpoint is an upsert: an existing schedule’s rules and timezone are replaced. Location PITs must be provisioned with the HighLevel permission: calendars.write.Input Parameters
Output
Create notification
Create notification
Create user availability schedule
Create user availability schedule
HIGHLEVEL_LOCATION_CALENDARS_CREATE_SCHEDULECreate new schedule with specified rules, timezone, location, user and calendar associations. Location PITs must be provisioned with the HighLevel permission: calendars.write.Input Parameters
Output
Create Service Booking
Create Service Booking
HIGHLEVEL_LOCATION_CALENDARS_CREATE_SERVICE_BOOKINGCreate a new service booking Location PITs must be provisioned with the HighLevel permission: calendars/events.write.Input Parameters
Output
Create Service
Create Service
HIGHLEVEL_LOCATION_CALENDARS_CREATE_SERVICE_CATALOGCreate new service in a location. Location PITs must be provisioned with the HighLevel permission: calendars.write.Input Parameters
Output
Create Service Location
Create Service Location
HIGHLEVEL_LOCATION_CALENDARS_CREATE_SERVICE_LOCATIONCreate a new service location Location PITs must be provisioned with the HighLevel permission: calendars.write.Input Parameters
Output
Delete Note
Delete Note
Delete Calendar
Delete Calendar
Delete Calendar Resource
Delete Calendar Resource
Delete Event
Delete Event
Delete Notification
Delete Notification
Delete Group
Delete Group
Delete user availability schedule
Delete user availability schedule
Delete Service Booking
Delete Service Booking
Delete Service
Delete Service
HIGHLEVEL_LOCATION_CALENDARS_DELETE_SERVICE_CATALOGDelete a service catalog item by ID. HighLevel soft-deletes the item: list operations exclude it, but a direct lookup by ID may still return it. Repeated deletion may also report success. Location PITs must be provisioned with the HighLevel permission: calendars.write.Input Parameters
Output
Delete Service Location
Delete Service Location
Disable Group
Disable Group
Update Appointment
Update Appointment
HIGHLEVEL_LOCATION_CALENDARS_EDIT_APPOINTMENTUpdate appointment Location PITs must be provisioned with the HighLevel permission: calendars/events.write.Input Parameters
calendar.locationConfigurationsor calendar.teamMembers[].locationConfigurationsaddress is provided in the request body, the meetingLocationType defaults to custom.meetingLocationId is provided - true - If only meetingLocationType is providedOutput
Update Block Slot
Update Block Slot
Update Group
Update Group
HIGHLEVEL_LOCATION_CALENDARS_EDIT_GROUPUpdate Group by group ID Location PITs must be provisioned with the HighLevel permission: calendars/groups.write.Input Parameters
Output
List Calendar Resources
List Calendar Resources
Get notification
Get notification
List user availability schedule
List user availability schedule
Get Appointment
Get Appointment
Get Notes
Get Notes
Get Blocked Slots
Get Blocked Slots
Get Calendar
Get Calendar
Get Calendar Events
Get Calendar Events
Get Calendar Resource
Get Calendar Resource
Get Calendars
Get Calendars
Get event calendar availability schedule
Get event calendar availability schedule
HIGHLEVEL_LOCATION_CALENDARS_GET_CALENDAR_SCHEDULERetrieve the availability schedule for a specific event calendar. Returns the schedule associated with the calendar ID provided in the path. Location PITs must be provisioned with the HighLevel permission: calendars.readonly.Input Parameters
Output
Get notifications
Get notifications
HIGHLEVEL_LOCATION_CALENDARS_GET_EVENT_NOTIFICATIONGet calendar notifications. When deleted is omitted, HighLevel can include soft-deleted notification settings; set deleted explicitly when filtering by deletion state. Location PITs must be provisioned with the HighLevel permission: calendars/events.readonly.Input Parameters
Output
Get Groups
Get Groups
Get user availability schedule
Get user availability schedule
HIGHLEVEL_LOCATION_CALENDARS_GET_SCHEDULE_BY_IDRetrieve a specific schedule by its unique identifier. Returns detailed information including rules, timezone, and associated calendars/users. Location PITs must be provisioned with the HighLevel permission: calendars.readonly.Input Parameters
Output
Get Service Booking by ID
Get Service Booking by ID
Get Service Bookings
Get Service Bookings
Get Service by ID
Get Service by ID
Get Service Location by ID
Get Service Location by ID
Get Service Locations
Get Service Locations
Get Services
Get Services
Get Free Slots
Get Free Slots
HIGHLEVEL_LOCATION_CALENDARS_GET_SLOTSGet free slots for a calendar between a date range. Optionally a consumer can also request free slots in a particular timezone and also for a particular user. Location PITs must be provisioned with the HighLevel permission: calendars.readonly.Input Parameters
Output
Remove user availability schedule from a calendar
Remove user availability schedule from a calendar
Update Note
Update Note
Update Calendar
Update Calendar
HIGHLEVEL_LOCATION_CALENDARS_UPDATE_CALENDARUpdate calendar by ID. HighLevel resets omitted slot duration, slot interval, form submit type, availability, notifications, and open hours to provider defaults, so resend those settings when they must be preserved. Location PITs must be provisioned with the HighLevel permission: calendars.write.Input Parameters
locationConfigurations.location or teamMembers[].locationConfigurations.location instead.Output
Update Calendar Resource
Update Calendar Resource
HIGHLEVEL_LOCATION_CALENDARS_UPDATE_CALENDAR_RESOURCEUpdate calendar resource by ID (Services V1) Location PITs must be provisioned with the HighLevel permission: calendars/resources.write.Input Parameters
Output
Update event calendar availability schedule
Update event calendar availability schedule
HIGHLEVEL_LOCATION_CALENDARS_UPDATE_CALENDAR_SCHEDULEUpdate the availability schedule for a specific event calendar. Only provided fields will be updated. The calendar ID is provided in the path. Location PITs must be provisioned with the HighLevel permission: calendars.write.Input Parameters
Output
Update notification
Update notification
HIGHLEVEL_LOCATION_CALENDARS_UPDATE_EVENT_NOTIFICATIONUpdate Event notification by id Location PITs must be provisioned with the HighLevel permission: calendars/events.write.Input Parameters
Output
Update user availability schedule
Update user availability schedule
Update Service Booking
Update Service Booking
HIGHLEVEL_LOCATION_CALENDARS_UPDATE_SERVICE_BOOKINGUpdate an existing service booking. For an ask_booker service location, every update must resend meeting_location. Location PITs must be provisioned with the HighLevel permission: calendars/events.write.Input Parameters
Output
Update Service
Update Service
HIGHLEVEL_LOCATION_CALENDARS_UPDATE_SERVICE_CATALOGUpdate service by ID. Location PITs must be provisioned with the HighLevel permission: calendars.write.Input Parameters
Output
Update Service Location
Update Service Location
HIGHLEVEL_LOCATION_CALENDARS_UPDATE_SERVICE_LOCATIONUpdate an existing service location Location PITs must be provisioned with the HighLevel permission: calendars.write.Input Parameters
Output
Validate group slug
Validate group slug
Get Campaigns
Get Campaigns
Clone Chat Widget
Clone Chat Widget
Create Chat Widget
Create Chat Widget
HIGHLEVEL_LOCATION_CHAT_WIDGET_CREATE_CHAT_WIDGETCreates a new chat widget for the connected sub-account. Location PITs must be provisioned with the HighLevel permission: chat-widget.write.Input Parameters
useEmailField and advanceSettings.aTwoPCompliance; manage those in the HighLevel app. acknowledgementDetails.icon accepts Check, CheckCircle, MessageDotsCircle, MessageSmileSquare, or an absolute URL. Use dimensions.position: bottom-right; documented left/right values are rejected. The documented STANDARD_FIELD value for advanceSettings.contactFormOptions[].dataType is also rejected.Output
Delete Chat Widget
Delete Chat Widget
Get Chat Widget
Get Chat Widget
Get Public Chat Widget Config
Get Public Chat Widget Config
List Chat Widgets
List Chat Widgets
HIGHLEVEL_LOCATION_CHAT_WIDGET_LIST_CHAT_WIDGETReturns chat widgets for the connected sub-account with pagination and optional filters. Location PITs must be provisioned with the HighLevel permission: chat-widget.readonly.Input Parameters
Output
Patch Chat Widget
Patch Chat Widget
HIGHLEVEL_LOCATION_CHAT_WIDGET_PATCH_CHAT_WIDGETPartially updates a chat widget in the connected sub-account. Location PITs must be provisioned with the HighLevel permission: chat-widget.write.Input Parameters
useEmailField and advanceSettings.aTwoPCompliance; manage those in the HighLevel app. acknowledgementDetails.icon accepts Check, CheckCircle, MessageDotsCircle, MessageSmileSquare, or an absolute URL. Use dimensions.position: bottom-right; documented left/right values are rejected. The documented STANDARD_FIELD value for advanceSettings.contactFormOptions[].dataType is also rejected.Output
Update Chat Widget
Update Chat Widget
HIGHLEVEL_LOCATION_CHAT_WIDGET_UPDATE_CHAT_WIDGETFully updates a chat widget in the connected sub-account. Preserve existing values, including settings, that should remain after this replacement. Location PITs must be provisioned with the HighLevel permission: chat-widget.write.Input Parameters
useEmailField and advanceSettings.aTwoPCompliance; manage those in the HighLevel app. acknowledgementDetails.icon accepts Check, CheckCircle, MessageDotsCircle, MessageSmileSquare, or an absolute URL. Use dimensions.position: bottom-right; documented left/right values are rejected. The documented STANDARD_FIELD value for advanceSettings.contactFormOptions[].dataType is also rejected.Output
Add Contact to Campaign
Add Contact to Campaign
Add Contact to Workflow
Add Contact to Workflow
Add Followers
Add Followers
Bulk Update Contact Business
Bulk Update Contact Business
HIGHLEVEL_LOCATION_CONTACTS_BULK_UPDATE_BUSINESSSubmit a job to assign one business to up to 50 contacts, or remove their business association with remove_business=true. HighLevel does not validate each contact ID before returning success:true, so that response means only that the job was accepted; verify important effects by reading the contacts. Confirm the contact IDs and intended association change before calling. No Contacts-specific PIT permission was enforced by the completed minimal-PIT probe.Input Parameters
Output
Create Contact
Create Contact
HIGHLEVEL_LOCATION_CONTACTS_CREATE_CONTACTCreate a new contact Location PITs must be provisioned with the HighLevel permission: contacts.write.Input Parameters
call and email; HighLevel rejects capitalized input keys even though read responses may capitalize them.Output
Create Note
Create Note
Create Task
Create Task
Delete Contact
Delete Contact
Delete Contact from Workflow
Delete Contact from Workflow
Delete Note
Delete Note
Delete Task
Delete Task
Get All Notes
Get All Notes
Get all Tasks
Get all Tasks
Get Appointments for Contact
Get Appointments for Contact
Get Contact
Get Contact
Get Contacts By BusinessId
Get Contacts By BusinessId
Get Duplicate Contact
Get Duplicate Contact
HIGHLEVEL_LOCATION_CONTACTS_GET_DUPLICATE_CONTACTGet Duplicate 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. Location PITs must be provisioned with the HighLevel permission: contacts.readonly.Input Parameters
Output
Get Note
Get Note
Get Task
Get Task
Remove Contact From Campaign
Remove Contact From Campaign
Remove Contact From Every Campaign
Remove Contact From Every Campaign
Remove Followers
Remove Followers
Search Contacts
Search Contacts
HIGHLEVEL_LOCATION_CONTACTS_SEARCH_CONTACTS_ADVANCEDSearch contacts using advanced filters and return one cursor-controlled page. Location PITs must be provisioned with the HighLevel permission: contacts.readonly.Input Parameters
Output
Update Contact
Update Contact
HIGHLEVEL_LOCATION_CONTACTS_UPDATE_CONTACTUpdate a contact using contactId Location PITs must be provisioned with the HighLevel permission: contacts.write.Input Parameters
Output
Update Note
Update Note
Update Task
Update Task
Update Task Completed
Update Task Completed
Upsert Contact
Upsert Contact
HIGHLEVEL_LOCATION_CONTACTS_UPSERT_CONTACTThe Upsert API will adhere to the configuration defined under the “Allow Duplicate Contact” setting at the Location level. If the setting is configured to check both Email and Phone, the API will attempt to identify an existing contact based on the priority sequence specified in the setting, and will create or update the contact accordingly. If two separate contacts already exist—one with the same email and another with the same phone—and an upsert request includes both the email and phone, the API will update the contact that matches the first field in the configured sequence, and ignore the second field to prevent duplication. Location PITs must be provisioned with the HighLevel permission: contacts.write.Input Parameters
true and the location allows duplicate contacts, a new contact will be created immediately without checking for duplicates. Scenario 2: If this value is true but the location does not allow duplicate contacts, this field is ignored and the normal upsert behavior applies: the API will search for an existing duplicate contact, update it if found, or create a new contact if not found. Scenario 3: If this value is false or not provided, the normal upsert behavior applies regardless of the location’s duplicate contact setting.Output
Attach Action to Agent
Attach Action to Agent
HIGHLEVEL_LOCATION_CONVERSATION_AI_CREATE_ACTIONCreates and attach a new action for an AI agent. Actions define specific tasks or behaviors that the agent can perform, such as booking appointments, sending follow-ups, or collecting information. Location PITs must be provisioned with the HighLevel permission: conversation-ai.write. Explicit confirmation is required before this mutation is sent.Input Parameters
type.Output
Create an Agent
Create an Agent
HIGHLEVEL_LOCATION_CONVERSATION_AI_CREATE_AGENTCreates a new AI agent for the location with a name, personality, goal, instructions, and optional behavior settings. Explicit confirmation is required, and location PITs must be provisioned with the HighLevel permission conversation-ai.write.Input Parameters
Output
Remove Action from Agent
Remove Action from Agent
HIGHLEVEL_LOCATION_CONVERSATION_AI_DELETE_ACTIONPermanently deletes an action. This will remove the action from all associated agents and cannot be undone. Location PITs must be provisioned with the HighLevel permission: conversation-ai.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Delete Agent
Delete Agent
HIGHLEVEL_LOCATION_CONVERSATION_AI_DELETE_AGENTDeletes an AI agent permanently. This action cannot be undone. All associated configurations and conversation history will be removed. Location PITs must be provisioned with the HighLevel permission: conversation-ai.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Get Action by ID
Get Action by ID
HIGHLEVEL_LOCATION_CONVERSATION_AI_GET_ACTION_BY_IDRetrieves detailed information about a specific action using its unique identifier. Returns the action configuration, associated agents, and performance metrics. Location PITs must be provisioned with the HighLevel permission: conversation-ai.readonly.Input Parameters
Output
Get Agent
Get Agent
Get the generation details
Get the generation details
HIGHLEVEL_LOCATION_CONVERSATION_AI_GET_GENERATION_DETAILSRetrieves detailed information about AI responses including the System Prompt, Conversation history, Knowledge base, website, FAQ chunks, and Rich Text chunks. Location PITs must be provisioned with the HighLevel permission: conversation-ai.readonly.Input Parameters
Output
List Actions for an Agent
List Actions for an Agent
Search Agents
Search Agents
HIGHLEVEL_LOCATION_CONVERSATION_AI_SEARCH_AGENTSearch AI agents by lowercase name query. The response has no has_more flag: omit start_after on the first page, then pass the last agent ID from the previous page and stop when count is 0. Location PITs must be provisioned with the HighLevel permission: conversation-ai.readonly.Input Parameters
Output
Update Action
Update Action
HIGHLEVEL_LOCATION_CONVERSATION_AI_UPDATE_ACTIONUpdates an existing action’s configuration. This includes modifying the action name, description, trigger conditions, and behavior settings. Location PITs must be provisioned with the HighLevel permission: conversation-ai.write. Explicit confirmation is required before this mutation is sent.Input Parameters
type. It must match the action’s existing type; HighLevel cannot change an action type and may clear its details when a different type is sent.Output
Update Agent
Update Agent
HIGHLEVEL_LOCATION_CONVERSATION_AI_UPDATE_AGENTFully replace the required personality, goal, and instructions of an existing AI agent; omitted optional fields keep their current values. Location PITs must be provisioned with the HighLevel permission: conversation-ai.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Update Followup Settings
Update Followup Settings
HIGHLEVEL_LOCATION_CONVERSATION_AI_UPDATE_FOLLOWUP_SETTINGSUpdate followupSettings for one or more advancedFollowup actions. HighLevel may retain omitted settings, so send every desired setting when deterministic replacement is required. HighLevel rejects IDs belonging to other action types. Location PITs must be provisioned with the HighLevel permission: conversation-ai.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Add an inbound message
Add an inbound message
HIGHLEVEL_LOCATION_CONVERSATIONS_ADD_AN_INBOUND_MESSAGEPost the necessary fields for the API to add a new inbound message. Location PITs must be provisioned with the HighLevel permission: conversations/message.write.Input Parameters
Output
Add an external outbound call
Add an external outbound call
Add message attachments
Add message attachments
HIGHLEVEL_LOCATION_CONVERSATIONS_ADD_MESSAGE_ATTACHMENTSSet attachments on an existing message (replaces existing). Maximum 5 URLs. Supported for TYPE_CUSTOM_CALL (34) and TYPE_CALL (1) with subType EXTERNAL_CALL. Location PITs must be provisioned with the HighLevel permission: conversations/message.write.Input Parameters
Output
Cancel a scheduled email message.
Cancel a scheduled email message.
Cancel a scheduled message.
Cancel a scheduled message.
Create Conversation
Create Conversation
Delete Conversation
Delete Conversation
Download transcription by Message ID
Download transcription by Message ID
Export messages by location ID
Export messages by location ID
HIGHLEVEL_LOCATION_CONVERSATIONS_EXPORT_MESSAGES_BY_LOCATIONReturn one page of messages for the connected HighLevel location, with a cursor for continuation. Location PITs must be provisioned with the HighLevel permission: conversations/message.readonly.Input Parameters
Output
Get Conversation
Get Conversation
Get email by Id
Get email by Id
Get message by message id
Get message by message id
Get Recording by Message ID
Get Recording by Message ID
Get messages by conversation id
Get messages by conversation id
Get transcription by Message ID
Get transcription by Message ID
Agent/Ai-Bot is typing a message indicator for live chat
Agent/Ai-Bot is typing a message indicator for live chat
HIGHLEVEL_LOCATION_CONVERSATIONS_LIVE_CHAT_AGENT_TYPINGSet the typing indicator for a conversation started by a live-chat widget visitor. This does not work for ordinary SMS, email, or other non-widget conversations; visitor_id must be that live-chat visitor’s ID. Location PITs must be provisioned with the HighLevel permission: conversations/livechat.write.Input Parameters
Output
Search Conversations
Search Conversations
HIGHLEVEL_LOCATION_CONVERSATIONS_SEARCH_CONVERSATIONReturn one page of conversations for the connected HighLevel location and an opaque cursor for the next page. Location PITs must be provisioned with the HighLevel permission: conversations.readonly.Input Parameters
Output
Send a new message
Send a new message
HIGHLEVEL_LOCATION_CONVERSATIONS_SEND_A_NEW_MESSAGESend a conversation message to a contact through the selected channel, or create an internal comment; external messages may notify or charge the recipient. Location PITs must be provisioned with conversations/message.write.Input Parameters
Output
Update Conversation
Update Conversation
Update email message status
Update email message status
HIGHLEVEL_LOCATION_CONVERSATIONS_UPDATE_EMAIL_MESSAGE_STATUSUpdate delivery events, per-recipient statuses, and the overall message status for an email sent via a custom conversation provider. ### Authorization - Requires the conversations/message.write OAuth scope. - The calling OAuth app must own the conversation provider that originally sent the email. - Attempts to update emails sent via LC Email or Mailgun will return 403 Forbidden. ### Updatable Fields status is required on every request. You may also include events and/or recipients. events — Aggregate delivery event counters (integers). Counters are merged into the existing values (not replaced). Setting a counter to 0 is treated as no-op and will not reset the stored value. recipients — Per-recipient delivery statuses. Each entry maps a recipient email address to a MessageStatus value. Use failReason to capture bounce or rejection… Location PITs must be provisioned with the HighLevel permission: conversations/message.write.Input Parameters
clicked will also set opened and delivered if not already present). See the endpoint description for the full inference rules.recipients array for granular tracking and this field for the aggregate status.Output
Update message status
Update message status
Upload file attachments
Upload file attachments
HIGHLEVEL_LOCATION_CONVERSATIONS_UPLOAD_FILE_ATTACHMENTSUpload conversation file attachments from URLs for a contact and conversation in the connected location. Location PITs must be provisioned with the HighLevel permission: conversations/message.write.Input Parameters
Output
Import Courses
Import Courses
Create Ad Platform Integration
Create Ad Platform Integration
HIGHLEVEL_LOCATION_CREATE_AD_PLATFORM_INTEGRATIONConnect one supported ad platform to the Location using the provider-specific account identifiers. This changes the Location’s active advertising integration and can replace or disrupt an existing connection; confirm the Location, platform, ad account, and MCC before calling. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
mccId. Not accepted for Facebook or LinkedIn.currencyCode. Not accepted for Facebook or Google.adAccountName. Not accepted for Facebook or Google.organizationId. Not accepted for Facebook or Google.Output
Create Custom Field
Create Custom Field
HIGHLEVEL_LOCATION_CUSTOM_FIELDS_CREATE_CUSTOM_FIELDCreate a custom field for a custom object or Company (Business) object in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: locations/customFields.write.Input Parameters
custom_objects.pet.name. A bare field name is also accepted and HighLevel prefixes it for the selected object.business for Company fields and custom_objects.<key> for custom objects.Output
Create Custom Field Folder
Create Custom Field Folder
HIGHLEVEL_LOCATION_CUSTOM_FIELDS_CREATE_CUSTOM_FIELD_FOLDERCreate a custom field folder for a custom object in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: locations/customFields.write.Input Parameters
business for Company fields and custom_objects.<key> for custom objects.Output
Delete Custom Field By ID
Delete Custom Field By ID
HIGHLEVEL_LOCATION_CUSTOM_FIELDS_DELETE_CUSTOM_FIELDPermanently delete a custom field by ID. HighLevel currently supports custom objects and Company (Business) objects for this operation. Location PITs must be provisioned with the HighLevel permission: locations/customFields.write.Input Parameters
Output
Delete Custom Field Folder
Delete Custom Field Folder
Get Custom Field / Folder By ID
Get Custom Field / Folder By ID
HIGHLEVEL_LOCATION_CUSTOM_FIELDS_GET_CUSTOM_FIELD_BY_IDGet a custom field or folder by ID. HighLevel currently supports custom objects and Company (Business) objects for this operation. Location PITs must be provisioned with the HighLevel permission: locations/customFields.readonly.Input Parameters
Output
Get Custom Fields By Object Key
Get Custom Fields By Object Key
HIGHLEVEL_LOCATION_CUSTOM_FIELDS_GET_CUSTOM_FIELDS_BY_OBJECT_KEYList custom fields and folders for an object key in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: locations/customFields.readonly.Input Parameters
business for Company fields and custom_objects.<key> for custom objects.Output
Update Custom Field By ID
Update Custom Field By ID
HIGHLEVEL_LOCATION_CUSTOM_FIELDS_UPDATE_CUSTOM_FIELDUpdate a custom field by ID in the connected HighLevel location. HighLevel currently supports custom objects and Company (Business) objects. Location PITs must be provisioned with the HighLevel permission: locations/customFields.write.Input Parameters
Output
Update Custom Field Folder Name
Update Custom Field Folder Name
HIGHLEVEL_LOCATION_CUSTOM_FIELDS_UPDATE_CUSTOM_FIELD_FOLDERRename a custom field folder in the connected HighLevel location. HighLevel currently supports custom objects and Company (Business) objects. Location PITs must be provisioned with the HighLevel permission: locations/customFields.write.Input Parameters
Output
Delete Ad Account Connection
Delete Ad Account Connection
HIGHLEVEL_LOCATION_DELETE_AD_ACCOUNT_CONNECTIONDisconnect an ad account from one supported ad platform. This does not delete the upstream ad account, but it disables Location workflows that depend on the connection; confirm the Location, platform, and account ID before calling. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.Input Parameters
adAccountId path parameter or a LinkedIn adAccountId query parameter.Output
Email Verification
Email Verification
HIGHLEVEL_LOCATION_EMAIL_ISV_VERIFY_EMAILVerify an email address or a HighLevel contact’s email. This may irreversibly deduct verification charges from the connected location or company wallet, and verification must be configured for that location. Location PITs must be provisioned with the HighLevel permission: lc-email.readonly.Input Parameters
Output
Create Email Campaign
Create Email Campaign
Create an email template
Create an email template
Create a template folder
Create a template folder
Delete Campaign
Delete Campaign
HIGHLEVEL_LOCATION_EMAILS_DELETE_CAMPAIGNDelete an email campaign. For a scheduled campaign, the first call cancels its schedule; call again only if the campaign should then be permanently deleted. Verify the campaign ID before calling. Location PITs must be provisioned with emails/campaigns.write.Input Parameters
Output
Delete a template
Delete a template
Get Bulk Action Campaign by ID
Get Bulk Action Campaign by ID
Get Campaign Statistics
Get Campaign Statistics
HIGHLEVEL_LOCATION_EMAILS_GET_CAMPAIGN_STATSGet statistics for an email, workflow, or bulk-action campaign. Location PITs must be provisioned with the HighLevel permission: emails/stats.readonly.Input Parameters
Output
Get Email Campaign by ID
Get Email Campaign by ID
Get Email Template by ID
Get Email Template by ID
Get Workflow Campaign by ID
Get Workflow Campaign by ID
Import an email template
Import an email template
List Bulk Action Campaigns
List Bulk Action Campaigns
List Email Campaigns
List Email Campaigns
HIGHLEVEL_LOCATION_EMAILS_LIST_EMAIL_CAMPAIGNSReturn one page of email campaigns for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: emails/campaigns.readonly.Input Parameters
Output
List templates
List templates
List Workflow Campaigns
List Workflow Campaigns
Schedule Campaign
Schedule Campaign
HIGHLEVEL_LOCATION_EMAILS_SCHEDULE_CAMPAIGNStart or schedule a draft or paused email campaign after validating recipients and schedule configuration. A cancelled campaign cannot be rescheduled; create a new draft. This can irreversibly send email to external recipients. Location PITs must be provisioned with the HighLevel permission: emails/campaigns.write.Input Parameters
Output
Update Email Campaign
Update Email Campaign
Update an email template
Update an email template
Get File by Slug
Get File by Slug
HIGHLEVEL_LOCATION_FILES_GET_FILE_BY_SLUGGet metadata and a short-lived signed download URL for a HighLevel file share slug. The documented response is JSON; this action does not follow the uncredentialed asset URL or forward provider credentials to its dynamic origin. Location PITs must have files.readonly.Input Parameters
Output
Get Forms
Get Forms
Get Forms Submissions
Get Forms Submissions
Upload Files to Custom Fields
Upload Files to Custom Fields
Create Redirect
Create Redirect
HIGHLEVEL_LOCATION_FUNNELS_CREATE_REDIRECTCreate a URL redirect for the connected HighLevel Location. The source domain must already be connected to the location. Location PITs must be provisioned with the HighLevel permission: funnels/redirect.write.Input Parameters
Output
Delete Redirect By ID
Delete Redirect By ID
Fetch Redirects List
Fetch Redirects List
Fetch List of Funnels
Fetch List of Funnels
Fetch List of Funnel Pages
Fetch List of Funnel Pages
Fetch Count of Funnel Pages
Fetch Count of Funnel Pages
Update Redirect By ID
Update Redirect By ID
Get Ad Account
Get Ad Account
HIGHLEVEL_LOCATION_GET_AD_ACCOUNTReturn one ad account or the selected account details for one ad platform. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
isDraft. Not accepted for LinkedIn.adAccountId path parameter or the LinkedIn adAccountId query parameter.Output
Get Ad Campaign Reporting
Get Ad Campaign Reporting
HIGHLEVEL_LOCATION_GET_AD_CAMPAIGN_REPORTINGReturn reporting metrics for one Facebook or Google ad campaign. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
Output
Get Ad Platform Integration
Get Ad Platform Integration
Get Ad Platform User
Get Ad Platform User
Get Ad Reporting
Get Ad Reporting
HIGHLEVEL_LOCATION_GET_AD_REPORTINGReturn aggregate reporting metrics for one connected ad platform. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
AD_MANAGER or INTEGRATION, sent as type. Not accepted for LinkedIn.pivot; not accepted for Facebook or Google.groupBy: Facebook accepts day, week, or month; Google accepts date, week, or month; LinkedIn accepts day, month, or year.entityUrns. Not accepted for Facebook or Google.Output
Manage Auto payment for an schedule invoice
Manage Auto payment for an schedule invoice
HIGHLEVEL_LOCATION_INVOICES_AUTO_PAYMENT_INVOICE_SCHEDULEAPI to manage auto payment for a schedule. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This may charge the contact’s configured payment method. This may create, change, or cancel future billing activity. Location PITs must be provisioned with the HighLevel permission: invoices/schedule.write.Input Parameters
Output
Cancel an scheduled invoice
Cancel an scheduled invoice
HIGHLEVEL_LOCATION_INVOICES_CANCEL_INVOICE_SCHEDULEAPI to cancel a scheduled invoice by schedule id. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This may create, change, or cancel future billing activity. This destructive change may be irreversible; confirm the target ID and intended outcome first. Location PITs must be provisioned with the HighLevel permission: invoices/schedule.write.Input Parameters
Output
Create Estimate Template
Create Estimate Template
HIGHLEVEL_LOCATION_INVOICES_CREATE_ESTIMATE_TEMPLATECreate a new estimate template. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: invoices/estimate.write.Input Parameters
charges entry must reference an existing charge _id and include enabled.Output
Create Invoice
Create Invoice
HIGHLEVEL_LOCATION_INVOICES_CREATE_INVOICEAPI to create an invoice. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: invoices.write.Input Parameters
charges entry must reference an existing charge _id and include enabled.Output
Create Invoice from Estimate
Create Invoice from Estimate
HIGHLEVEL_LOCATION_INVOICES_CREATE_INVOICE_FROM_ESTIMATECreate a new invoice from an existing estimate. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: invoices/estimate.write.Input Parameters
Output
Create Invoice Schedule
Create Invoice Schedule
HIGHLEVEL_LOCATION_INVOICES_CREATE_INVOICE_SCHEDULEAPI to create an invoice Schedule. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This may create, change, or cancel future billing activity. Location PITs must be provisioned with the HighLevel permission: invoices/schedule.write.Input Parameters
charges entry must reference an existing charge _id and include enabled.Output
Create template
Create template
HIGHLEVEL_LOCATION_INVOICES_CREATE_INVOICE_TEMPLATECreate an invoice template. HighLevel stores internal=true as false and drops items[].type. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: invoices/template.write.Input Parameters
charges entry must reference an existing charge _id and include enabled.Output
Create New Estimate
Create New Estimate
HIGHLEVEL_LOCATION_INVOICES_CREATE_NEW_ESTIMATECreate a new estimate for the connected HighLevel location, optionally sending it while saving. Location private integration tokens must have the invoices/estimate.write permission.Input Parameters
charges entry must reference an existing charge _id and include enabled.Output
Delete Estimate
Delete Estimate
HIGHLEVEL_LOCATION_INVOICES_DELETE_ESTIMATEDelete an existing estimate. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This destructive change may be irreversible; confirm the target ID and intended outcome first. Location PITs must be provisioned with the HighLevel permission: invoices/estimate.write.Input Parameters
Output
Delete Estimate Template
Delete Estimate Template
HIGHLEVEL_LOCATION_INVOICES_DELETE_ESTIMATE_TEMPLATEDelete an existing estimate template. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This destructive change may be irreversible; confirm the target ID and intended outcome first. Location PITs must be provisioned with the HighLevel permission: invoices/estimate.write.Input Parameters
Output
Delete invoice
Delete invoice
HIGHLEVEL_LOCATION_INVOICES_DELETE_INVOICEPermanently delete a draft invoice by ID. HighLevel rejects deletion after the invoice leaves draft. Confirm the target ID and intended outcome first. Location PITs must be provisioned with the HighLevel permission: invoices.write.Input Parameters
Output
Delete schedule
Delete schedule
HIGHLEVEL_LOCATION_INVOICES_DELETE_INVOICE_SCHEDULEAPI to delete an schedule by schedule id. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This may create, change, or cancel future billing activity. This destructive change may be irreversible; confirm the target ID and intended outcome first. Location PITs must be provisioned with the HighLevel permission: invoices/schedule.write.Input Parameters
Output
Delete template
Delete template
Generate Estimate Number
Generate Estimate Number
Generate Invoice Number
Generate Invoice Number
Get invoice
Get invoice
Get an schedule
Get an schedule
Get Invoice Settings
Get Invoice Settings
Get an template
Get an template
List Estimates
List Estimates
List Estimate Templates
List Estimate Templates
List invoices
List invoices
List schedules
List schedules
List templates
List templates
Preview Estimate Template
Preview Estimate Template
Record a manual payment for an invoice
Record a manual payment for an invoice
HIGHLEVEL_LOCATION_INVOICES_RECORD_INVOICERecord a manual payment against an invoice. Omit amount to record the full remaining balance; payment-plan invoices accept only scheduled step amounts. This irreversibly changes the invoice’s financial balance; verify the invoice, amount, method, and payment schedule before calling. Location PITs must be provisioned with the HighLevel permission: invoices.write.Input Parameters
Output
Schedule an schedule invoice
Schedule an schedule invoice
HIGHLEVEL_LOCATION_INVOICES_SCHEDULE_INVOICE_SCHEDULEAPI to schedule an schedule invoice to start sending to the customer. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. This may create, change, or cancel future billing activity. Location PITs must be provisioned with the HighLevel permission: invoices/schedule.write.Input Parameters
Output
Send Estimate
Send Estimate
HIGHLEVEL_LOCATION_INVOICES_SEND_ESTIMATESend an estimate by ID using email, SMS, both, or a manual-send operation. Location PITs must be provisioned with the HighLevel permission: invoices/estimate.write.Input Parameters
Output
Send invoice
Send invoice
HIGHLEVEL_LOCATION_INVOICES_SEND_INVOICESend an invoice by ID via email, SMS, or both, or mark it as sent manually. Location PITs must be provisioned with the HighLevel permission: invoices.write.Input Parameters
Output
Create & Send
Create & Send
HIGHLEVEL_LOCATION_INVOICES_TEXT2PAY_INVOICECreate or update a text-to-pay invoice for the connected HighLevel location in draft or send mode. HighLevel ignores the title, terms notes, and sent-to details for this operation. Location private integration tokens must have the invoices.write permission.Input Parameters
charges entry must reference an existing charge _id and include enabled.Output
Update scheduled recurring invoice
Update scheduled recurring invoice
HIGHLEVEL_LOCATION_INVOICES_UPDATE_AND_SCHEDULE_INVOICE_SCHEDULEReplace the contents of an invoice schedule that is already in scheduled state; call SCHEDULE_INVOICE_SCHEDULE first for a draft. The request is a full replacement, so include every existing invoice, schedule, and auto-payment setting that must be preserved; omitting tipsConfiguration, paymentMethods, or automaticTaxesEnabled clears it. Review currency, amounts, taxes, discounts, fees, and payment settings because this changes future billing activity and may charge the contact. Location PITs must be provisioned with the HighLevel permission: invoices/schedule.write.Input Parameters
rrule or executeAt. The schedule must already be in scheduled state; include every setting that must be preserved.charges entry must reference an existing charge _id and include enabled.Output
Update Estimate
Update Estimate
HIGHLEVEL_LOCATION_INVOICES_UPDATE_ESTIMATEUpdate an existing estimate. Omitted terms_notes, payment_schedule_config, automatic_taxes_enabled, and live_mode are cleared. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: invoices/estimate.write.Input Parameters
charges entry must reference an existing charge _id and include enabled.Output
Update estimate last visited at
Update estimate last visited at
HIGHLEVEL_LOCATION_INVOICES_UPDATE_ESTIMATE_LAST_VISITED_ATUpdate an estimate’s last-visited timestamp by estimate ID. The estimate must already be in the sent state. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: invoices/estimate.write.Input Parameters
Output
Update Estimate Template
Update Estimate Template
HIGHLEVEL_LOCATION_INVOICES_UPDATE_ESTIMATE_TEMPLATEUpdate an existing estimate template. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: invoices/estimate.write.Input Parameters
charges entry must reference an existing charge _id and include enabled.Output
Update invoice
Update invoice
HIGHLEVEL_LOCATION_INVOICES_UPDATE_INVOICEUpdate an invoice by invoice ID. Omitting payment_schedule clears the stored payment schedule. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: invoices.write.Input Parameters
charges entry must reference an existing charge _id and include enabled.Output
Update Invoice Last Visited At
Update Invoice Last Visited At
Update Invoice Late Fees Configuration
Update Invoice Late Fees Configuration
HIGHLEVEL_LOCATION_INVOICES_UPDATE_INVOICE_LATE_FEES_CONFIGURATIONReplace late-fee settings on an invoice in the connected Location. Confirm the amount, type, frequency, grace period, and cap before changing this financial record. Location PITs must be provisioned with the HighLevel permission: invoices.write.Input Parameters
Output
Update schedule
Update schedule
HIGHLEVEL_LOCATION_INVOICES_UPDATE_INVOICE_SCHEDULEReplace an invoice schedule by schedule ID. The request is a full replacement, so include every existing invoice and schedule setting that must be preserved; omitting tipsConfiguration, paymentMethods, or automaticTaxesEnabled clears it. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record and future billing activity. Location PITs must be provisioned with the HighLevel permission: invoices/schedule.write.Input Parameters
rrule or executeAt. This update replaces the schedule object, so include every existing schedule setting that must be preserved.charges entry must reference an existing charge _id and include enabled.Output
Update template
Update template
HIGHLEVEL_LOCATION_INVOICES_UPDATE_INVOICE_TEMPLATEUpdate an invoice template by ID. HighLevel nulls attachments, tipsConfiguration, paymentMethods, and automaticTaxesEnabled on every update, even when they are sent. Review currency, amounts, taxes, discounts, fees, and payment settings before calling because this changes a financial record. Location PITs must be provisioned with the HighLevel permission: invoices/template.write.Input Parameters
charges entry must reference an existing charge _id and include enabled.Output
Update Template Late Fees Configuration
Update Template Late Fees Configuration
HIGHLEVEL_LOCATION_INVOICES_UPDATE_INVOICE_TEMPLATE_LATE_FEES_CONFIGURATIONReplace an invoice template’s late-fee configuration in the connected Location using a Location private integration token provisioned with invoices.write. Confirm the fee amount, type, frequency, grace period, and cap before calling.Input Parameters
Output
Update Template Payment Methods Configuration
Update Template Payment Methods Configuration
HIGHLEVEL_LOCATION_INVOICES_UPDATE_INVOICE_TEMPLATE_PAYMENT_METHODS_CONFIGURATIONReplace payment-method settings on an invoice template in the connected Location using a Location private integration token provisioned with invoices.write. Confirm the intended bank-debit behavior before calling.Input Parameters
Output
Void invoice
Void invoice
HIGHLEVEL_LOCATION_INVOICES_VOID_INVOICEVoid a non-draft invoice by ID without deleting its record. Draft invoices cannot be voided, and any paid amount must be refunded before voiding. Confirm the intended accounting outcome because this financial change is irreversible. Location PITs must be provisioned with invoices.write.Input Parameters
Output
Create Knowledge Base FAQ
Create Knowledge Base FAQ
Create Knowledge Base
Create Knowledge Base
Delete Knowledge Base FAQ
Delete Knowledge Base FAQ
Delete Knowledge Base
Delete Knowledge Base
Delete Trained Knowledge Base URLs
Delete Trained Knowledge Base URLs
Discover Website for Knowledge Base
Discover Website for Knowledge Base
List Knowledge Base Crawler URLs
List Knowledge Base Crawler URLs
Get Knowledge Base Crawler Status
Get Knowledge Base Crawler Status
Get Knowledge Base
Get Knowledge Base
List Knowledge Bases
List Knowledge Bases
HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_LIST_ALL_KNOWLEDGE_BASES_PAGINATEDReturn one page of knowledge bases for the connected location. Location PITs require knowledge-bases.readonly.Input Parameters
Output
List Knowledge Base FAQs
List Knowledge Base FAQs
Train Discovered Knowledge Base URLs
Train Discovered Knowledge Base URLs
HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_TRAIN_DISCOVERED_URLSQueue discovered pages for training after explicit confirmation. A successful response confirms queue acceptance, not that the URL IDs existed or training completed; poll crawler status to verify progress. Location PITs require knowledge-bases.write.Input Parameters
Output
Update Knowledge Base FAQ
Update Knowledge Base FAQ
Update Knowledge Base
Update Knowledge Base
Create Link
Create Link
Delete Link
Delete Link
Get Link by ID
Get Link by ID
Get Links
Get Links
Search Trigger Links
Search Trigger Links
Update Link
Update Link
List Ad Accounts
List Ad Accounts
HIGHLEVEL_LOCATION_LIST_AD_ACCOUNTSList ad accounts available through one connected ad platform. Facebook supports type, fetch_all, and cursor-based next; type=AD_MANAGER filters to the account used by HighLevel Ad Manager. limit is not exposed because HighLevel ignores it. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
next. Not accepted for Google or LinkedIn.INTEGRATION or AD_MANAGER. Not accepted for LinkedIn.isDraft. Not accepted for Facebook or Google.fetchAll. Not accepted for Google or LinkedIn.Output
List Ad Reports
List Ad Reports
HIGHLEVEL_LOCATION_LIST_AD_REPORTSList published reporting entities for one connected ad platform. Facebook drafts are not returned; use Get campaign with linked entities for a HighLevel draft. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
type (for example, AD_MANAGER or INTEGRATION). Not accepted for LinkedIn.fields value. Not accepted for Facebook or Google.ads, adsets, or campaigns; Google accepts campaigns, adGroups, keywords, or ads; LinkedIn accepts campaignGroups, campaigns, or ads.campaigns or ads and sent as campaignGroupId. Not accepted for Facebook or Google.Output
Create Custom Field
Create Custom Field
HIGHLEVEL_LOCATION_LOCATIONS_CREATE_CUSTOM_FIELDCreate a custom field in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/customFields.write.Input Parameters
Output
Create Custom Value
Create Custom Value
Create Recurring Task
Create Recurring Task
HIGHLEVEL_LOCATION_LOCATIONS_CREATE_RECURRING_TASKCreate Recurring Task Location PITs must be provisioned with the HighLevel permission: recurring-tasks.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Create Tag
Create Tag
Delete Custom Field
Delete Custom Field
Delete Custom Value
Delete Custom Value
Delete Recurring Task
Delete Recurring Task
HIGHLEVEL_LOCATION_LOCATIONS_DELETE_RECURRING_TASKDelete Recurring Task Location PITs must be provisioned with the HighLevel permission: recurring-tasks.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Delete Tag
Delete Tag
Get Email, SMS, or WhatsApp Templates
Get Email, SMS, or WhatsApp Templates
HIGHLEVEL_LOCATION_LOCATIONS_GET_ALL_OR_EMAIL_SMS_TEMPLATESReturn one offset-based page of templates from the connected HighLevel Location. Pass next_cursor back as cursor to retrieve the next page. Location PITs must be provisioned with the HighLevel permission: locations/templates.readonly.Input Parameters
originId field or the template-management UI/API.Output
Get Conversation Channel
Get Conversation Channel
Get Custom Field
Get Custom Field
Get Custom Fields
Get Custom Fields
Get Custom Value
Get Custom Value
Get Custom Values
Get Custom Values
Get Sub-Account (Formerly Location)
Get Sub-Account (Formerly Location)
Get Recurring Task By Id
Get Recurring Task By Id
Get Tag by ID
Get Tag by ID
Fetch Timezones
Fetch Timezones
Task Search Filter
Task Search Filter
Update Custom Field
Update Custom Field
HIGHLEVEL_LOCATION_LOCATIONS_UPDATE_CUSTOM_FIELDUpdate a custom field in the connected HighLevel Location, looking up the existing field and reusing available values for omitted replacement fields. Location PITs must be provisioned with the HighLevel permission: locations/customFields.write.Input Parameters
Output
Update Custom Value
Update Custom Value
Update Recurring Task
Update Recurring Task
HIGHLEVEL_LOCATION_LOCATIONS_UPDATE_RECURRING_TASKUpdate Recurring Task Location PITs must be provisioned with the HighLevel permission: recurring-tasks.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Update Tag
Update Tag
Upload File to Custom Fields
Upload File to Custom Fields
Check Wallet Funds
Check Wallet Funds
Create Wallet Charge
Create Wallet Charge
HIGHLEVEL_LOCATION_MARKETPLACE_CREATE_WALLET_CHARGECreate a real wallet charge for the connected HighLevel Location. The Location and its parent Company are resolved from the OAuth connection, and explicit confirmation is required.Input Parameters
Output
Delete Wallet Charge
Delete Wallet Charge
Get Marketplace Installer Details
Get Marketplace Installer Details
Get Marketplace Rebilling Config
Get Marketplace Rebilling Config
Get Wallet Charge
Get Wallet Charge
List Wallet Charges
List Wallet Charges
Uninstall Marketplace Application
Uninstall Marketplace Application
HIGHLEVEL_LOCATION_MARKETPLACE_UNINSTALL_APPLICATIONUninstall an application from the connected HighLevel Location. This removes the application’s access and stops its functionality, so explicit confirmation is required.Input Parameters
Output
Bulk Delete / Trash Files or Folders
Bulk Delete / Trash Files or Folders
HIGHLEVEL_LOCATION_MEDIAS_BULK_DELETE_MEDIA_OBJECTSDelete or trash multiple files and folders in the connected Location, with explicit confirmation; review per-item results for partial failures. Location PITs must be provisioned with the HighLevel permission medias.write.Input Parameters
Output
Bulk Update Files / Folders
Bulk Update Files / Folders
Create Media Folder
Create Media Folder
Delete File or Folder
Delete File or Folder
Get List of Files / Folders
Get List of Files / Folders
Update File / Folder
Update File / Folder
Upload File into Media Storage
Upload File into Media Storage
Create Object Record
Create Object Record
HIGHLEVEL_LOCATION_OBJECTS_CREATE_OBJECT_RECORDCreate a business or custom object record with schema-defined fields. Location PITs must be provisioned with the HighLevel permission: objects/record.write.Input Parameters
properties, for example {"properties":{"name":"Buddy"}}, and optionally accepts followers as a top-level array of user IDs. Top-level owner and flat property keys are rejected.Output
Delete Object Record
Delete Object Record
List Location Objects
List Location Objects
Get Object Schema by Key
Get Object Schema by Key
Get Object Record
Get Object Record
Search Object Records
Search Object Records
HIGHLEVEL_LOCATION_OBJECTS_SEARCH_OBJECT_RECORDSReturn one page of business or custom object records matching a search expression. Location PITs must be provisioned with the HighLevel permission: objects/record.readonly.Input Parameters
Output
Update Object Schema
Update Object Schema
HIGHLEVEL_LOCATION_OBJECTS_UPDATE_CUSTOM_OBJECTUpdate a custom object’s labels, description, and searchable fields, or update searchable fields for a standard object. Custom object keys must include the custom_objects. prefix. searchable_properties replaces the complete searchable-field list. Location PITs must be provisioned with the HighLevel permission: objects/schema.write.Input Parameters
custom_objects. prefix; standard keys may be used to update searchable fields.Output
Update Object Record
Update Object Record
HIGHLEVEL_LOCATION_OBJECTS_UPDATE_OBJECT_RECORDUpdate a standard or custom object record with schema-defined fields. Custom object schema keys include the custom_objects. prefix. Location PITs must be provisioned with the HighLevel permission: objects/record.write.Input Parameters
custom_objects. prefix.Output
Add Followers
Add Followers
HIGHLEVEL_LOCATION_OPPORTUNITIES_ADD_FOLLOWERS_OPPORTUNITYAdd up to 10 user IDs as followers of an opportunity and return the resulting follower list. HighLevel may report an unknown user as followersAdded:[[]]; verify the resulting followers list when user IDs are not known-valid. Location PITs must be provisioned with the HighLevel permission: opportunities.write.Input Parameters
Output
Create Opportunity
Create Opportunity
HIGHLEVEL_LOCATION_OPPORTUNITIES_CREATE_OPPORTUNITYCreate an opportunity. HighLevel rejects a duplicate opportunity for the same contact in the same pipeline. Location PITs must be provisioned with the HighLevel permission: opportunities.write.Input Parameters
Output
Create Pipeline
Create Pipeline
HIGHLEVEL_LOCATION_OPPORTUNITIES_CREATE_PIPELINECreate a pipeline with at least one stage in the connected HighLevel location. Pipeline and stage names must be unique. Explicit confirmation is required. Location PITs must have pipelines.create.Input Parameters
name and position; set each stage’s showInFunnel and showInPieChart explicitly because pipeline-level visibility flags do not propagate to stages.Output
Delete Opportunity
Delete Opportunity
Delete Pipeline
Delete Pipeline
HIGHLEVEL_LOCATION_OPPORTUNITIES_DELETE_PIPELINEPermanently delete a pipeline and every opportunity in all its stages. This is irreversible and requires explicit confirmation. Location PITs must have pipelines.write.Input Parameters
Output
Get lost reason
Get lost reason
Get Opportunity
Get Opportunity
Get Pipeline
Get Pipeline
Get Pipelines
Get Pipelines
Remove Followers
Remove Followers
Search Opportunities
Search Opportunities
HIGHLEVEL_LOCATION_OPPORTUNITIES_SEARCH_OPPORTUNITIES_ADVANCEDSearch opportunities in the connected location using a text query, with pagination and optional related details. Location PITs must be provisioned with the HighLevel permission: opportunities.readonly.Input Parameters
Output
Search Opportunity
Search Opportunity
Update Opportunity
Update Opportunity
HIGHLEVEL_LOCATION_OPPORTUNITIES_UPDATE_OPPORTUNITYUpdate Opportunity. Location PITs must be provisioned with the HighLevel permission: opportunities.write.Input Parameters
Output
Update Opportunity Status
Update Opportunity Status
Update Pipeline
Update Pipeline
HIGHLEVEL_LOCATION_OPPORTUNITIES_UPDATE_PIPELINEUpdate a pipeline. The stage list is a full replacement and removing stages migrates their opportunities, so explicit confirmation is required. Location PITs must have pipelines.write.Input Parameters
name and position; existing stages also require their IDs. Set each stage’s showInFunnel and showInPieChart explicitly because pipeline-level visibility flags do not propagate. Removed-stage opportunities migrate to the lowest-position remaining stage.Output
Upsert Opportunity
Upsert Opportunity
HIGHLEVEL_LOCATION_OPPORTUNITIES_UPSERT_OPPORTUNITYUpsert Opportunity. Location PITs must be provisioned with the HighLevel permission: opportunities.write.Input Parameters
Output
Create Coupon
Create Coupon
Create Custom Payment Integration
Create Custom Payment Integration
HIGHLEVEL_LOCATION_PAYMENTS_CREATE_INTEGRATIONCreate a custom payment-provider association for the connected Location. Review all external URLs and subscription support before creating financial infrastructure. Location PITs must be provisioned with the HighLevel permission: payments/custom-provider.write.Input Parameters
Output
Create White-label Integration Provider
Create White-label Integration Provider
HIGHLEVEL_LOCATION_PAYMENTS_CREATE_INTEGRATION_PROVIDERCreate a Location payment-provider integration backed by Authorize.net or NMI. Review the provider, public URLs, and Location before creating financial infrastructure. Location PITs must be provisioned with the HighLevel permission: payments/integration.write.Input Parameters
Output
Create Order Fulfillment
Create Order Fulfillment
HIGHLEVEL_LOCATION_PAYMENTS_CREATE_ORDER_FULFILLMENTCreate fulfillment history for an order. Confirm order, item quantities, tracking data, and whether a customer notification should be sent before calling. Location PITs must be provisioned with the HighLevel permission: payments/orders.write.Input Parameters
Output
Update Custom Provider Capabilities
Update Custom Provider Capabilities
HIGHLEVEL_LOCATION_PAYMENTS_CUSTOM_PROVIDER_MARKETPLACE_APP_UPDATE_CAPABILITIESSet whether the connected Location’s custom payment provider supports subscription schedules. Confirm downstream recurring-billing behavior before disabling support. Location PITs must be provisioned with the HighLevel permission: payments/custom-provider.write.Input Parameters
Output
Delete Coupon
Delete Coupon
Delete Custom Payment Integration
Delete Custom Payment Integration
Disconnect Custom Payment Provider Config
Disconnect Custom Payment Provider Config
HIGHLEVEL_LOCATION_PAYMENTS_DISCONNECT_CONFIGDisconnect a custom provider’s live or test payment configuration. Disconnecting live mode can stop charges and subscriptions; confirm the Location, mode, and operational impact before calling. Location PITs must be provisioned with the HighLevel permission: payments/custom-provider.write.Input Parameters
Output
Fetch Custom Payment Provider Config
Fetch Custom Payment Provider Config
Get Coupon
Get Coupon
HIGHLEVEL_LOCATION_PAYMENTS_GET_COUPONRetrieve coupon details by ID for the connected Location. The endpoint requires code, but HighLevel currently ignores it when selecting the coupon. Location PITs must be provisioned with the HighLevel permission: payments/coupons.readonly.Input Parameters
id and ignores this value.Output
Get Order by ID
Get Order by ID
Get Subscription by ID
Get Subscription by ID
Get Transaction by ID
Get Transaction by ID
List Coupons
List Coupons
List White-label Integration Providers
List White-label Integration Providers
List Order Fulfillment
List Order Fulfillment
List Order Notes
List Order Notes
List Orders
List Orders
List Subscriptions
List Subscriptions
List Transactions
List Transactions
Record Order Payment
Record Order Payment
HIGHLEVEL_LOCATION_PAYMENTS_RECORD_ORDER_PAYMENTRecord a real manual payment against an order. This changes financial balances and may mark the order paid; confirm the order ID, amount, currency, payment method, and partial-payment intent before calling. Do not use this action to test connectivity. Location PITs must be provisioned with the HighLevel permission: payments/orders.collectPayment.Input Parameters
Output
Update Coupon
Update Coupon
List Active Numbers
List Active Numbers
HIGHLEVEL_LOCATION_PHONE_SYSTEM_ACTIVE_NUMBERSList one page of active numbers and phone-account state for the connected HighLevel location. Pass next_cursor back as page for the next page. This action depends on external phone-system state. Location PITs must be provisioned with the HighLevel permission: phonenumbers.read.Input Parameters
Output
List Number Pools
List Number Pools
List Available Phone Numbers
List Available Phone Numbers
HIGHLEVEL_LOCATION_PHONE_SYSTEM_LIST_AVAILABLE_NUMBERS_FOR_ACOUNTRYSearch external phone-provider inventory for numbers purchasable by the connected HighLevel location. This does not purchase or reserve a number. Location PITs must be provisioned with the HighLevel permission: phonenumbers.read.Input Parameters
Output
Purchase Number for Location
Purchase Number for Location
HIGHLEVEL_LOCATION_PHONE_SYSTEM_PURCHASE_NUMBER_FOR_LOCATIONPurchase a phone number for the connected HighLevel location from external provider inventory. This can incur an immediate charge. Explicit confirmation is required, and this toolkit surface has no action for releasing the number. HighLevel rejects purchases when the location is not KYC verified, including when skip_location_kyc is true. Location PITs must be provisioned with the HighLevel permission: phonenumbers.write.Input Parameters
fingerprintId returned by PHONE_SYSTEM_LIST_AVAILABLE_NUMBERS_FOR_ACOUNTRY for the search that found this number.Output
Bulk Edit Products and Prices
Bulk Edit Products and Prices
HIGHLEVEL_LOCATION_PRODUCTS_BULK_EDITEdit products and nested prices in one request, with explicit confirmation and at most 30 product and price entities combined. Location PITs must be provisioned with the HighLevel permission products.write.Input Parameters
Output
Bulk Update Products
Bulk Update Products
HIGHLEVEL_LOCATION_PRODUCTS_BULK_UPDATEBulk-update product prices, availability, collections, or currency, or permanently delete products when type is bulk-delete-products. Collection updates add products to collections and never remove existing collection assignments. Confirm the operation type and product IDs before calling. Location PITs must be provisioned with the HighLevel permission: products.write.Input Parameters
Output
Bulk Update Product Reviews
Bulk Update Product Reviews
Create Price for a Product
Create Price for a Product
HIGHLEVEL_LOCATION_PRODUCTS_CREATE_PRICE_FOR_PRODUCTThe “Create Price for a Product” API allows adding a new price associated with a specific product to the system. Use this endpoint to create a price with the specified details for a particular product. Ensure that the required information is provided in the request payload. Location PITs must be provisioned with the HighLevel permission: products/prices.write.Input Parameters
Output
Create Product
Create Product
HIGHLEVEL_LOCATION_PRODUCTS_CREATE_PRODUCTThe “Create Product” API allows adding a new product to the system. Use this endpoint to create a product with the specified details. Ensure that the required information is provided in the request payload. Location PITs must be provisioned with the HighLevel permission: products.write.Input Parameters
Output
Create Product Collection
Create Product Collection
Delete Price by ID for a Product
Delete Price by ID for a Product
HIGHLEVEL_LOCATION_PRODUCTS_DELETE_PRICE_BY_ID_FOR_PRODUCTThe “Delete Price by ID for a Product” API allows deleting a specific price associated with a particular product using its unique identifier. Use this endpoint to remove a price from the system. Location PITs must be provisioned with the HighLevel permission: products/prices.write.Input Parameters
Output
Delete Product by ID
Delete Product by ID
HIGHLEVEL_LOCATION_PRODUCTS_DELETE_PRODUCT_BY_IDThe “Delete Product by ID” API allows deleting a specific product using its unique identifier. Use this endpoint to remove a product from the system. Location PITs must be provisioned with the HighLevel permission: products.write.Input Parameters
Output
Delete Product Collection
Delete Product Collection
Delete Product Review
Delete Product Review
List Inventory
List Inventory
HIGHLEVEL_LOCATION_PRODUCTS_GET_LIST_INVENTORYThe “List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the inventory based on the provided query parameters. Location PITs must be provisioned with the HighLevel permission: products/prices.readonly.Input Parameters
Output
Get Price by ID for a Product
Get Price by ID for a Product
HIGHLEVEL_LOCATION_PRODUCTS_GET_PRICE_BY_ID_FOR_PRODUCTThe “Get Price by ID for a Product” API allows retrieving information for a specific price associated with a particular product using its unique identifier. Use this endpoint to fetch details for a single price based on the provided price ID and product ID. Location PITs must be provisioned with the HighLevel permission: products/prices.readonly.Input Parameters
Output
Get Product by ID
Get Product by ID
HIGHLEVEL_LOCATION_PRODUCTS_GET_PRODUCT_BY_IDThe “Get Product by ID” API allows to retrieve information for a specific product using its unique identifier. Use this endpoint to fetch details for a single product based on the provided product ID. Location PITs must be provisioned with the HighLevel permission: products.readonly.Input Parameters
Output
Fetch Product Collections
Fetch Product Collections
HIGHLEVEL_LOCATION_PRODUCTS_GET_PRODUCT_COLLECTIONFetch product collections for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: products/collection.readonly.Input Parameters
Output
Get Details about individual product collection
Get Details about individual product collection
Fetch Product Reviews
Fetch Product Reviews
HIGHLEVEL_LOCATION_PRODUCTS_GET_PRODUCT_REVIEWSFetch product reviews for the connected location with a required moderation status of pending or approved. Location PITs must be provisioned with the HighLevel permission: products.readonly.Input Parameters
Output
Fetch Product Store Stats
Fetch Product Store Stats
HIGHLEVEL_LOCATION_PRODUCTS_GET_PRODUCT_STORE_STATSAPI to fetch the total number of products, included in the store, and excluded from the store and other stats Location PITs must be provisioned with the HighLevel permission: products.readonly.Input Parameters
_id from the funnel list where isStoreActive is true), not a page or step ID.Output
Fetch Review Count as per status
Fetch Review Count as per status
List Prices for a Product
List Prices for a Product
HIGHLEVEL_LOCATION_PRODUCTS_LIST_PRICES_FOR_PRODUCTThe “List Prices for a Product” API allows retrieving a paginated list of prices associated with a specific product. Customize your results by filtering prices or paginate through the list using the provided query parameters. Location PITs must be provisioned with the HighLevel permission: products/prices.readonly.Input Parameters
Output
List Products
List Products
HIGHLEVEL_LOCATION_PRODUCTS_LIST_PRODUCTSThe “List Products” API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve product information. Location PITs must be provisioned with the HighLevel permission: products.readonly.Input Parameters
Output
Update Product Display Priorities
Update Product Display Priorities
HIGHLEVEL_LOCATION_PRODUCTS_UPDATE_DISPLAY_PRIORITYSet product display priorities for a store in the connected Location. Confirm the complete intended ordering before calling. Location PITs must be provisioned with the HighLevel permission: products.write.Input Parameters
_id from the funnel list where isStoreActive is true), not a page or step ID.Output
Update Inventory
Update Inventory
HIGHLEVEL_LOCATION_PRODUCTS_UPDATE_INVENTORYThe Update Inventory API allows the user to bulk update the inventory for multiple items. Use this endpoint to update the available quantity and out-of-stock purchase settings for multiple items in the inventory. Location PITs must be provisioned with the HighLevel permission: products/prices.write.Input Parameters
Output
Update Price by ID for a Product
Update Price by ID for a Product
HIGHLEVEL_LOCATION_PRODUCTS_UPDATE_PRICE_BY_ID_FOR_PRODUCTReplace a product price by ID. This is a full replacement: resend every field to retain, including SKU, description, recurring schedule, trial period, total cycles, setup fee, compare-at price, shipping options, inventory settings, and digital-delivery settings. Omitted optional fields are cleared. Location PITs must be provisioned with the HighLevel permission: products/prices.write.Input Parameters
Output
Update Product by ID
Update Product by ID
HIGHLEVEL_LOCATION_PRODUCTS_UPDATE_PRODUCT_BY_IDUpdate a product by ID. HighLevel ignores product_type and clears taxInclusive when tax_inclusive is omitted. Location PITs must be provisioned with the HighLevel permission: products.write.Input Parameters
Output
Update Product Collection
Update Product Collection
Update Product Review
Update Product Review
Update Product Store Inclusion
Update Product Store Inclusion
HIGHLEVEL_LOCATION_PRODUCTS_UPDATE_STORE_STATUSAPI to update the status of products in a particular store Location PITs must be provisioned with the HighLevel permission: products.write.Input Parameters
_id from the funnel list where isStoreActive is true), not a page or step ID.Output
List Proposal Documents
List Proposal Documents
HIGHLEVEL_LOCATION_PROPOSALS_LIST_DOCUMENTS_CONTRACTSReturn one page of proposal and contract documents for the connected HighLevel location. Availability may depend on an account entitlement that has not been verified. Location PITs must be provisioned with the HighLevel permission: documents_contracts/list.readonly.Input Parameters
Output
List Proposal Templates
List Proposal Templates
HIGHLEVEL_LOCATION_PROPOSALS_LIST_DOCUMENTS_CONTRACTS_TEMPLATESReturn one page of proposal and contract templates for the connected HighLevel location. Availability may depend on an account entitlement that has not been verified. Location PITs must be provisioned with the HighLevel permission: documents_contracts_template/list.readonly.Input Parameters
Output
Send Proposal Document
Send Proposal Document
HIGHLEVEL_LOCATION_PROPOSALS_SEND_DOCUMENTS_CONTRACTSIrreversibly send an existing proposal or contract to external recipients for the connected HighLevel location. Review the document, recipients, sender, and delivery medium before calling. Availability may depend on an unverified account entitlement. Location PITs must be provisioned with the HighLevel permission: documents_contracts/sendLink.write.Input Parameters
email sends an external email; link requests link delivery.Output
Create or Send Proposal from Template
Create or Send Proposal from Template
HIGHLEVEL_LOCATION_PROPOSALS_SEND_DOCUMENTS_CONTRACTS_TEMPLATECreate a proposal or contract from a template for a contact in the connected HighLevel location. Setting send_document=true or omitting it sends externally and is irreversible; pass false to create a draft. Availability may depend on an unverified account entitlement. Location PITs must be provisioned with the HighLevel permission: documents_contracts_template/sendLink.write.Input Parameters
Output
Search Ad Targeting
Search Ad Targeting
HIGHLEVEL_LOCATION_SEARCH_AD_TARGETINGSearch targeting options on Facebook Ads, Google Ads, or LinkedIn Ads. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.Input Parameters
geolocation, interest, or language; Google accepts geolocation or language. Not accepted for LinkedIn.query. Required for Facebook, optional for Google and LinkedIn.searchType. Not accepted for Google or LinkedIn.Output
Connect Account (Step 3 of 3)
Connect Account (Step 3 of 3)
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_ATTACH_OAUTH_ACCOUNTSAttach an account returned by SOCIAL_PLANNER_GET_OAUTH_ACCOUNTS (step 2 of the OAuth flow). Copy its provider identifiers unchanged: Instagram requires page_id; LinkedIn requires type and urn; YouTube, Threads, and Pinterest require type=‘profile’; Google Business Profile requires both location and account. Location PITs must be provisioned with the HighLevel permission: socialplanner/oauth.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Clone a queue item
Clone a queue item
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_CLONE_QUEUE_ITEMDuplicates an existing queue item at a specified order position. Requires an active edit session. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Create a comment or reply
Create a comment or reply
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_CREATE_COMMENTCreate a top-level post comment (isParentThread: true, parentId = post ID) or reply (isParentThread: false, parentId = comment ID). Attachments work only on Facebook; mentions work on Facebook, LinkedIn, and Community; notifyAllGroupMembers broadcasts only in Community and is ignored elsewhere. Content limits are Facebook 8000, Instagram 2200, LinkedIn 3000, Community 8000, TikTok 150, Bluesky 300, YouTube 10000, and Threads 500 characters. Location PITs must be provisioned with socialplanner/comments.write. Explicit confirmation is required.Input Parameters
isParentThread: true) or internal parent comment ID for a reply (isParentThread: false).true to create a top-level comment on a post (parentId = post ID). Set false to create a reply to an existing comment (parentId = comment ID).true, all members of the Community group receive a push/in-app notification about this comment — equivalent to an @everyone broadcast. Supported on: Community only. Ignored on all other platforms (the field is accepted but no notification is sent). Independent of the mentions array — you do not need to add an @everyone entry to mentions for this to take effect. Conversely, putting the literal text @everyone in content does not by itself trigger notifications; only this flag does. Defaults to false (no broadcast notification). Use true only when the comment is genuinely intended for every member of the group — overuse may cause members to mute the group.Output
Like a comment
Like a comment
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_CREATE_LIKELike a comment using its HighLevel comment ID on Facebook, LinkedIn, Community, TikTok, or Bluesky; explicit confirmation is required. Location PITs must be provisioned with socialplanner/comments.write.Input Parameters
Output
Create post
Create post
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_CREATE_POSTCreate a draft or publish/schedule content on connected external social networks. An immediate published request can succeed without returning a post ID; recover the created record with SOCIAL_PLANNER_GET_POSTS using a narrow from_date/to_date window around creation. Non-draft requests require explicit confirmation because they may make content public or notify followers. Location PITs must be provisioned with the HighLevel permission: socialplanner/post.write.Input Parameters
_id field from each tag. Validation: All IDs must be valid MongoDB ObjectIds.post - Standard feed post (all platforms) - story - Temporary 24-hour story (Instagram, Facebook) - reel - Short-form video content (Instagram, Facebook, TikTok, YouTube) Customize Per Platform: You can specify different content/types per platform using facebookPostDetails.type, instagramPostDetails.type, etc. Validations: - Reels require exactly 1 video - Stories: Caption not supported for Instagram/Facebook - Facebook Groups do not support Reelsscheduled and in_review require schedule_date; every status, including draft, requires at least one account ID.{{contact.name}}) - Hashtags: Use #hashtag format. Instagram allows max 30 hashtags. - Mentions: Use platform-specific mention format (see mentions field for structured mentions) Validations: - Instagram/Facebook Story: Caption NOT supported for direct publishing - Facebook, LinkedIn, GMB: Content OR media is required (at least one) - Content is automatically trimmed to platform limits Reference: Platform Limitations Guideid field from the user object. Validation: Must be a valid MongoDB ObjectId._id field. Validation: Must be a valid MongoDB ObjectId.title: Video title (max 100 characters) - type: Video type (video for regular videos, short for YouTube Shorts) - privacyLevel: Video visibility (private, public, unlisted) Limits: - Max 1 video per post - Caption (description) max 5,000 characters Requirements: - Video is REQUIRED for YouTube posts - type field is requiredtype: Post type (post, story, reel) Restrictions: - Facebook Groups do NOT support Reels - Reels require exactly 1 video - Stories do not support captions Reference: Platform Limitations GuidepostAsPdf: Set to true to post images as a PDF carousel document - pdfTitle: Title for the PDF document (max 100 characters) Limits: - Max 9 images/videos for regular posts - Max 300 pages for PDF carousel - Max PDF size: 100 MB Reference: Platform Limitations Guidetype: Post type (post, story, reel) - collaborators: Map of account IDs to Instagram usernames for collaboration invites (max 3 per account) - showOnFeed: Show reel on profile feed (for reels) Collaborators Structure: json { "accountId": ["username1", "username2"] } Where accountId is from Get Accounts API and usernames are Instagram handles without @. Restrictions: - Media is REQUIRED for all Instagram posts - Max 30 hashtags allowed in caption - Stories do not support captions - Collaborators: Posts/Reels only (NOT Stories) - Reels require exactly 1 video Reference: Platform Limitations GuideboardIds: Object mapping account OAuth IDs to Pinterest board IDs Optional Fields: - title: Pin title (max 100 characters) - link: Destination URL for the pin (max 2048 characters) Get Board IDs: Use the Pinterest boards API or retrieve from connected account details. Limits: - Max 1 image/video per pin - Caption max 800 characters Reference: Platform Limitations GuideOutput
Create a new category queue
Create a new category queue
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_CREATE_QUEUECreates a queue in draft status for a category. Published posts are auto-added. Use update endpoint to activate. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Create a new item in the queue
Create a new item in the queue
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_CREATE_QUEUE_ITEMAdds a new post item to a queue. Use sessionId for edit session or directToQueue for immediate addition. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.write. Explicit confirmation is required before this mutation is sent.Input Parameters
content.sessionId can also create a live item. When true, order is ignored and placement follows the queue’s prioritizeNewContent setting.Output
Delete Account
Delete Account
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_DELETE_ACCOUNTDelete account and account from group Location PITs must be provisioned with the HighLevel permission: socialplanner/account.write.Input Parameters
Output
Delete CSV
Delete CSV
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_DELETE_CSVDelete a CSV import and all its associated posts Location PITs must be provisioned with the HighLevel permission: socialplanner/csv.write.Input Parameters
Output
Delete CSV Post
Delete CSV Post
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_DELETE_CSV_POSTDelete a specific post from a CSV import Location PITs must be provisioned with the HighLevel permission: socialplanner/csv.write.Input Parameters
Output
Delete an active post and schedule the next one
Delete an active post and schedule the next one
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_DELETE_CURRENT_ACTIVE_POST_AND_SCHEDULE_NEXTDeletes a post that is currently scheduled and automatically triggers the scheduling of the next available post in the queue. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Unlike a comment
Unlike a comment
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_DELETE_LIKERemove a like from a comment using its HighLevel comment ID on Facebook, LinkedIn, Community, TikTok, or Bluesky. Explicit confirmation is required, and location PITs must have the socialplanner/comments.write permission.Input Parameters
Output
Delete Post
Delete Post
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_DELETE_POSTSoft-delete one Social Planner post from HighLevel idempotently through the bulk-delete operation. Repeating the deletion may still report deletedCount: 1, and SOCIAL_PLANNER_GET_POSTS does not list these records with its deleted filter. This does not guarantee removal from an external social network. Location PITs must be provisioned with the HighLevel permission: socialplanner/post.write.Input Parameters
Output
Delete an item from a queue
Delete an item from a queue
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_DELETE_QUEUE_ITEMDeletes an item from a specific category queue. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Discard edit session changes
Discard edit session changes
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_DISCARD_EDIT_SESSIONCancels the edit session and deletes all staged changes without affecting the live queue. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Edit post
Edit post
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_EDIT_POSTEdit an existing Social Planner post and optionally republish or reschedule it on its connected external networks. This PUT replaces stored post fields: GET the post first and resend values such as category, schedule date, and media that must be preserved. Non-draft changes require explicit confirmation because they may update public content or notify followers. Location PITs must be provisioned with the HighLevel permission: socialplanner/post.write.Input Parameters
_id field from each tag. Validation: All IDs must be valid MongoDB ObjectIds.post - Standard feed post (all platforms) - story - Temporary 24-hour story (Instagram, Facebook) - reel - Short-form video content (Instagram, Facebook, TikTok, YouTube) Customize Per Platform: You can specify different content/types per platform using facebookPostDetails.type, instagramPostDetails.type, etc. Validations: - Reels require exactly 1 video - Stories: Caption not supported for Instagram/Facebook - Facebook Groups do not support Reelsdraft - Post saved as draft, not yet ready for publishing - scheduled - Post scheduled for future publishing (requires scheduleDate) - in_review - Post pending approval (requires scheduleDate and postApprovalDetails) - published - Post has been published - in_progress - Post is currently being processed - pending - Post is awaiting platform processing for Instagram media container creation - failed - Post publishing failed - notification_sent - Story notification sent (for manual story posting) - deleted - Post has been deleted Draft edits still require valid accountIds; only media/content requirements may vary by destination.{{contact.name}}) - Hashtags: Use #hashtag format. Instagram allows max 30 hashtags. - Mentions: Use platform-specific mention format (see mentions field for structured mentions) Validations: - Instagram/Facebook Story: Caption NOT supported for direct publishing - Facebook, LinkedIn, GMB: Content OR media is required (at least one) - Content is automatically trimmed to platform limits Reference: Platform Limitations Guideid field from the user object. Validation: Must be a valid MongoDB ObjectId._id field. Validation: Must be a valid MongoDB ObjectId.title: Video title (max 100 characters) - type: Video type (video for regular videos, short for YouTube Shorts) - privacyLevel: Video visibility (private, public, unlisted) Limits: - Max 1 video per post - Caption (description) max 5,000 characters Requirements: - Video is REQUIRED for YouTube posts - type field is requiredtype: Post type (post, story, reel) Restrictions: - Facebook Groups do NOT support Reels - Reels require exactly 1 video - Stories do not support captions Reference: Platform Limitations GuidepostAsPdf: Set to true to post images as a PDF carousel document - pdfTitle: Title for the PDF document (max 100 characters) Limits: - Max 9 images/videos for regular posts - Max 300 pages for PDF carousel - Max PDF size: 100 MB Reference: Platform Limitations Guidetype: Post type (post, story, reel) - collaborators: Map of account IDs to Instagram usernames for collaboration invites (max 3 per account) - showOnFeed: Show reel on profile feed (for reels) Collaborators Structure: json { "accountId": ["username1", "username2"] } Where accountId is from Get Accounts API and usernames are Instagram handles without @. Restrictions: - Media is REQUIRED for all Instagram posts - Max 30 hashtags allowed in caption - Stories do not support captions - Collaborators: Posts/Reels only (NOT Stories) - Reels require exactly 1 video Reference: Platform Limitations GuideboardIds: Object mapping account OAuth IDs to Pinterest board IDs Optional Fields: - title: Pin title (max 100 characters) - link: Destination URL for the pin (max 2048 characters) Get Board IDs: Use the Pinterest boards API or retrieve from connected account details. Limits: - Max 1 image/video per pin - Caption max 800 characters Reference: Platform Limitations GuideOutput
Get all categories with their queue status
Get all categories with their queue status
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_FETCH_AVAILABLE_CATEGORIESReturns categories with status: “available” (no queue), “in_queue” (active/paused queue), or “draft” (queue in draft). Location PITs must be provisioned with the HighLevel permission: socialplanner/category.readonly.Input Parameters
Output
Get scheduled posts calendar view
Get scheduled posts calendar view
Fetch calendar view for an edit session
Fetch calendar view for an edit session
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_FETCH_EDIT_SESSION_CALENDARRetrieves a calendar preview of scheduled posts based on draft items within an edit session. This shows how posts would be scheduled if changes were saved. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.readonly.Input Parameters
Output
Fetch a category queue by ID
Fetch a category queue by ID
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_FETCH_QUEUE_BY_IDRetrieves the details of a single category queue by its unique ID. The response includes a count of posts within the queue that have errors. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.readonly.Input Parameters
Output
Fetch items from a queue
Fetch items from a queue
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_FETCH_QUEUE_ITEMSReturns paginated queue items. Pass sessionId to get draft items from an edit session instead of live items. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.readonly.Input Parameters
Output
Fetch category queues for a location
Fetch category queues for a location
Fetch slot information for queue items
Fetch slot information for queue items
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_FETCH_SLOTSReturns paginated slot information (scheduledDateTime, isSkipped) for queue items. Pass sessionId to get slots for draft items, or omit for live items. Call this after mutations to refresh slot data. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.readonly.Input Parameters
Output
Get Accounts
Get Accounts
Get categories by id
Get categories by id
Get categories by location id
Get categories by location id
List comments for a post or thread
List comments for a post or thread
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_GET_COMMENT_LISTPaginated list of comments scoped to a post (parentId = postId) or a comment thread (parentId = commentId). Use skip/limit for pagination, sortBy for ordering, originIds to filter by connected account, and search for keyword search. Location PITs must be provisioned with the HighLevel permission: socialplanner/comments.readonly.Input Parameters
toDate is also required, and fromDate must be ≤ toDate. Omit both to disable date filtering.originIds. Must be a valid 24-character Highlevel ID, not the native platform ID.Output
Get CSV Post
Get CSV Post
Get Available Accounts (Step 2 of 3)
Get Available Accounts (Step 2 of 3)
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_GET_OAUTH_ACCOUNTSStep 2 of the Social Planner OAuth flow: after Start OAuth returns an account ID, list the Facebook pages, Instagram professional accounts, Google Business Profile locations, LinkedIn organizations, TikTok accounts, YouTube channels, Pinterest accounts, Threads profiles, or Bluesky profiles available to attach. Pass the selected result to the attach-account action. Location PITs must be provisioned with the HighLevel permission: socialplanner/oauth.readonly.Input Parameters
Output
Get post
Get post
Get posts
Get posts
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_GET_POSTSGet Social Planner posts. Use a narrow from_date/to_date window to recover an immediately published post when SOCIAL_PLANNER_CREATE_POST succeeds without returning a post ID. Location PITs must be provisioned with the HighLevel permission: socialplanner/post.readonly.Input Parameters
Output
Get Upload Status
Get Upload Status
Reset an item in a queue
Reset an item in a queue
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_RESET_QUEUE_ITEMReset a staged queue item to its original state. For a live item with no original staged version, HighLevel deletes the item instead of restoring it. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Save edit session changes
Save edit session changes
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_SAVE_EDIT_SESSIONApplies all staged changes to the live queue and closes the edit session. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Set Accounts
Set Accounts
Start CSV Finalize
Start CSV Finalize
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_START_CSV_FINALIZEFinalize a CSV import and schedule all posts for publishing Location PITs must be provisioned with the HighLevel permission: socialplanner/csv.write.Input Parameters
Output
Start or resume an edit session
Start or resume an edit session
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_START_EDIT_SESSIONCreates a draft copy of queue items for editing. Starting another session for the same queue silently expires the previous session, so reuse the returned session ID until changes are saved or discarded. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Update queue settings or status
Update queue settings or status
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_UPDATE_QUEUEUpdates queue status (active/paused/deleted), time slots, or skip dates. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.write. Explicit confirmation is required before this mutation is sent.Input Parameters
Output
Update an item in a queue
Update an item in a queue
HIGHLEVEL_LOCATION_SOCIAL_PLANNER_UPDATE_QUEUE_ITEMUpdate the content, variations, or order of a specific item in a category queue. Explicit confirmation is required; Location PITs require socialplanner/category.write.Input Parameters
content.accountIds and userId are required; media defaults to an empty array.Output
Upload CSV
Upload CSV
Create Shipping Carrier
Create Shipping Carrier
Create Shipping Rate
Create Shipping Rate
Create Shipping Zone
Create Shipping Zone
Delete Shipping Carrier
Delete Shipping Carrier
Delete Shipping Rate
Delete Shipping Rate
Delete Shipping Zone
Delete Shipping Zone
Get Available Shipping Rates
Get Available Shipping Rates
HIGHLEVEL_LOCATION_STORE_GET_AVAILABLE_SHIPPING_RATESCalculate available shipping-rate quotes without changing provider state. HighLevel rejects amount_available=true, so omit it. A whole-country zone shadows state-specific zones, including when the whole-country zone has no rates. No endpoint-specific provider permission was evidenced beyond a valid Location token.Input Parameters
Output
Get Shipping Carrier
Get Shipping Carrier
Get Shipping Rate
Get Shipping Rate
Get Shipping Zone
Get Shipping Zone
Get Store Settings
Get Store Settings
List Shipping Carriers
List Shipping Carriers
List Shipping Rates
List Shipping Rates
List Shipping Zones
List Shipping Zones
Update Shipping Carrier
Update Shipping Carrier
Update Shipping Rate
Update Shipping Rate
HIGHLEVEL_LOCATION_STORE_UPDATE_SHIPPING_RATEUpdate a shipping rate after explicit confirmation. HighLevel resets is_carrier_rate to false when it is omitted, so resend is_carrier_rate and shipping_carrier_id when updating a carrier rate. For carrier rates, HighLevel overwrites the supplied rate name with the selected carrier’s name. Location PITs require store/shipping.write.Input Parameters
Output
Update Shipping Zone
Update Shipping Zone
Get Surveys
Get Surveys
Get Surveys Submissions
Get Surveys Submissions
Delete User
Delete User
Get User
Get User
Search Users
Search Users
Update User
Update User
HIGHLEVEL_LOCATION_USERS_UPDATE_USERUpdate non-password fields of an existing HighLevel user. Location PITs must be provisioned with the HighLevel permission: users.write.Input Parameters
Output
Create Voice AI Agent Action
Create Voice AI Agent Action
HIGHLEVEL_LOCATION_VOICE_AI_CREATE_ACTIONCreate a behavior or capability for an existing Voice AI agent in the connected HighLevel Location. This mutates the agent and may require Voice AI entitlement. Location PITs must be provisioned with the HighLevel permission: voice-ai-agent-goals.write.Input Parameters
Output
Create Voice AI Agent
Create Voice AI Agent
HIGHLEVEL_LOCATION_VOICE_AI_CREATE_AGENTCreate a Voice AI agent in the connected HighLevel Location. This changes the Location and may require Voice AI subscription entitlement or activation. Location PITs must be provisioned with the HighLevel permission: voice-ai-agents.write.Input Parameters
Output
Delete Voice AI Agent Action
Delete Voice AI Agent Action
HIGHLEVEL_LOCATION_VOICE_AI_DELETE_ACTIONPermanently remove an action and its configuration from a Voice AI agent in the connected HighLevel Location. This operation cannot be undone. Location PITs must be provisioned with the HighLevel permission: voice-ai-agent-goals.write.Input Parameters
Output
Delete Voice AI Agent
Delete Voice AI Agent
HIGHLEVEL_LOCATION_VOICE_AI_DELETE_AGENTPermanently delete a Voice AI agent and its configuration from the connected HighLevel Location. This operation is destructive and cannot be undone. Location PITs must be provisioned with the HighLevel permission: voice-ai-agents.write.Input Parameters
Output
Get Voice AI Agent Action
Get Voice AI Agent Action
HIGHLEVEL_LOCATION_VOICE_AI_GET_ACTIONRetrieve one action configured for a Voice AI agent in the connected HighLevel Location. Voice AI availability may require product entitlement. Location PITs must be provisioned with the HighLevel permission: voice-ai-agent-goals.readonly.Input Parameters
Output
Get Voice AI Agent
Get Voice AI Agent
HIGHLEVEL_LOCATION_VOICE_AI_GET_AGENTRetrieve one Voice AI agent owned by the connected HighLevel Location. Voice AI availability may depend on the Location’s subscription or activation. Location PITs must be provisioned with the HighLevel permission: voice-ai-agents.readonly.Input Parameters
Output
List Voice AI Agents
List Voice AI Agents
HIGHLEVEL_LOCATION_VOICE_AI_GET_AGENTSList Voice AI agents in the connected HighLevel Location. Returns one page and an opaque continuation cursor; access may require Voice AI entitlement. Location PITs must be provisioned with the HighLevel permission: voice-ai-agents.readonly.Input Parameters
Output
Get Voice AI Call Log
Get Voice AI Call Log
List Voice AI Call Logs
List Voice AI Call Logs
HIGHLEVEL_LOCATION_VOICE_AI_GET_CALL_LOGSList Voice AI call logs in the connected HighLevel Location with documented filters, sorting, and one-page continuation. Access may require entitlement. Location PITs must be provisioned with the HighLevel permission: voice-ai-dashboard.readonly.Input Parameters
Output
Update Voice AI Agent
Update Voice AI Agent
HIGHLEVEL_LOCATION_VOICE_AI_PATCH_AGENTPartially update a Voice AI agent in the connected HighLevel Location. Only provided fields change; this mutation may require Voice AI entitlement. Location PITs must be provisioned with the HighLevel permission: voice-ai-agents.write.Input Parameters
Output
Update Voice AI Agent Action
Update Voice AI Agent Action
HIGHLEVEL_LOCATION_VOICE_AI_UPDATE_ACTIONReplace an existing Voice AI agent action configuration in the connected HighLevel Location. This mutates call behavior and may require entitlement. Location PITs must be provisioned with the HighLevel permission: voice-ai-agent-goals.write.