Skip to main content
HighLevel Location logo
  • Category: crm
  • Auth: OAUTH2, BEARER_TOKEN
  • Composio-managed OAuth available? No
  • Tools: 555
  • Triggers: 0
  • Slug: HIGHLEVEL_LOCATION
  • Version: 20261101_00

Tools

Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_ADD_CUSTOM_AUDIENCE_MEMBERAdd a member to a Facebook custom audience Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Contact identifier
string
required
Custom audience identifier
string
Facebook ad account ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
CSV file path
string
required
Custom audience identifier
array
Smartlist IDs array
string ("ADD" | "REMOVE" | "REPLACE")
required
Batch operation type
string ("true" | "false")
String boolean flag required by HighLevel: true or false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_CREATE_CONVERSATION_FORMCreate a new Facebook conversation lead form. HighLevel exposes no delete counterpart for conversation forms. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Conversation form name
string
required
Welcome message text
array
required
Quick-reply questions shown in the welcome message of the conversation form

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Lead form name
string ("MORE_VOLUME" | "HIGHER_INTENT")
required
Lead form type
string
Locale
string
required
Facebook page identifier
boolean
If the form is a draft, set to true
array
List of questions displayed on the lead form. Required (non-empty) when isDraft is false or omitted; optional for drafts.
string
Existing draft ID to clean up after publishing a non-draft form. When is_draft=true, HighLevel creates a new draft with a new ID rather than updating this ID; drafts cannot be deleted through this toolkit.
object
Greeting card config
object
Thank you page config. Required when isDraft is false or omitted; optional for drafts.
object
Custom disclaimer config
Privacy policy URL. Required when isDraft is false or omitted; optional for drafts.
string
Privacy policy text
string
Question page headline

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_DELETE_ADPermanently delete a Facebook ad. Unlike campaign and ad-set deletion, this is a hard delete and a repeated delete returns not found. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Ad identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_DELETE_ADSETArchive a Facebook ad set and remove its ads. This is a soft delete: the ad set may remain readable with publishingStatus=ARCHIVED. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Ad set identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Campaign identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_DELETE_CUSTOM_AUDIENCEDelete a Facebook custom audience by ID Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

boolean
Is draft
string
required
Custom audience identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_DELETE_INTEGRATIONRemove the Facebook ad integration from a location Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Facebook page ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_DUPLICATE_ADDuplicate an existing Facebook ad Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Ad identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_DUPLICATE_ADSETDuplicate an existing Facebook ad set Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Ad set identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_DUPLICATE_CAMPAIGNDuplicate an existing Facebook campaign Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Campaign identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Comma-separated expansions. Pass adsets,ads to include nested adsets and their ads; they are omitted otherwise.
string
Campaign data source
string
required
Campaign identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether to read publishing progress for a draft campaign.
string
required
Facebook campaign identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_GET_CONVERSATION_FORMSRetrieve Facebook conversation lead forms for a location Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

boolean
Is draft

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_GET_CUSTOM_AUDIENCE_BY_IDRetrieve a specific Facebook custom audience by its ID Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

boolean
Is draft
string
required
Custom audience identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("lookalike" | "custom" | "all")
required
Audience list type
string ("ad_manager" | "integration")
Audience data source
string
required
Ad account identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination cursor
string ("AD_MANAGER" | "INTEGRATION")
required
Integration source type
string
Meta ad set identifier used to filter ads.
string ("true" | "false")
Fetch all entities
string
Meta entity ID to search for.
string
Meta campaign identifier used to filter ad sets or ads.
string ("CAMPAIGN" | "ADSET" | "AD")
required
Entity type to fetch
string
Selected Meta ad account ID. Required when type is INTEGRATION.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_GET_INSTAGRAM_ACCOUNTSRetrieve Instagram accounts linked to a specific Facebook page Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

string ("INTEGRATION" | "AD_MANAGER")
Integration type
string
required
Facebook page identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Set true for a draft ID from Get page lead forms; either its draft_ prefix or bare ID is accepted. Omitting this for a draft produces HighLevel’s generic get-form error.
string
required
Lead form identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Facebook page identifier
boolean
Is draft

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_GET_PAGESRetrieve Facebook pages associated with the connected account Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

string ("true" | "false")
Whether to fetch existing pages

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("IG" | "FACEBOOK")
Channel type
string
Facebook page ID
string
Instagram user ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_PAUSE_ADPause a published Facebook ad. Draft or otherwise unpublished ads cannot be paused. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Ad identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_PAUSE_ADSETPause a published Facebook ad set. Draft or otherwise unpublished ad sets cannot be paused. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Ad set identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_PAUSE_CAMPAIGNPause a published Facebook campaign. Draft or otherwise unpublished campaigns cannot be paused. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Campaign identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_PUBLISH_CAMPAIGNPublish a Facebook campaign and push it live to Facebook Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Campaign identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_REMOVE_CUSTOM_AUDIENCE_MEMBERRemove a member from a Facebook custom audience Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Contact identifier
string
required
Custom audience identifier
string
Facebook ad account ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_RESUME_ADResume a paused Facebook ad. The ad must already be published and paused. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Ad identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_RESUME_ADSETResume a paused Facebook ad set. The ad set must already be published and paused. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Ad set identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_RESUME_CAMPAIGNResume a paused Facebook campaign. The campaign must already be published and paused. Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Campaign identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Facebook page identifier
boolean
Is draft

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_FB_UPDATE_CUSTOM_AUDIENCEUpdate a Facebook custom audience’s name and optionally its description. Location PITs must be provisioned with the HighLevel permission adPublishing.write.

Input Parameters

string
required
Audience name
string
required
Custom audience identifier
string
Audience description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Ad identifier
string ("NO_BUTTON" | "ADD_TO_CART" | "APPLY_NOW" | "BET_NOW" | "BOOK_TRAVEL" | "BUY_NOW" | "BUY_TICKETS" | "CALL_NOW" | "CONTACT_US" | "DOWNLOAD" | "GET_DIRECTIONS" | "GET_OFFER" | "GET_QUOTE" | "GO_LIVE" | "INSTALL_MOBILE_APP" | "LEARN_MORE" | "LIKE_PAGE" | "LISTEN_MUSIC" | "OPEN_LINK" | "ORDER_NOW" | "PLAY_GAME" | "REGISTER_NOW" | "REQUEST_TIME" | "SAVE" | "MESSAGE_PAGE" | "WHATSAPP_MESSAGE" | "SHOP_NOW" | "SIGN_UP" | "SUBSCRIBE" | "USE_APP" | "WATCH_MORE" | "WATCH_VIDEO")
Meta call-to-action token shown on the ad. Use NO_BUTTON for no CTA; choose a listed value compatible with the campaign objective and supply the matching destination_link, destination_form_id, conversation_form_id, or messaging destination when that CTA requires one.
string
Ad name
array
Media items (images or videos) attached to the ad creative
string
required
Parent HighLevel ad set ID
string
Ad headline text
string
Ad image URL
string ("SINGLE" | "CAROUSEL")
Ad media type
string
required
Parent HighLevel campaign ID
string
Ad description text
string
Ad primary text
Destination link URL
string
Destination form ID
string
Conversation form ID
boolean
Enable multi-advertiser ads

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Ad set identifier
string
Ad set name
object
Ad set budget. Publishing requires budgetType and amount; the amount uses major units of the ad account currency.
string
Facebook page ID
object
Targeting audience configuration including geo-locations, locales, placements, and custom audiences
string
Conversion pixel ID
number
Bid cap or cost-per-result goal in the ad account currency. Required when the parent campaign uses LOWEST_COST_WITH_BID_CAP or COST_CAP.
string
required
Parent HighLevel campaign ID
string
WhatsApp phone number
string
Custom event type
string
Instagram actor ID
string
Conversion location
array
Messaging platforms

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Campaign identifier
string
Campaign name
string
Campaign data source
string ("OUTCOME_LEADS" | "OUTCOME_TRAFFIC" | "OUTCOME_ENGAGEMENT" | "OUTCOME_SALES")
Campaign objective
array
Special ad categories

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pixel name
string ("LEAD_EVENT" | "FUNNEL_EVENT" | "INSTAGRAM_DM")
required
Pixel event type
string
Instagram user ID
string
Conversion pixel ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
CSV file path
boolean
Dynamic list flag
string
required
Required numeric Google Ads user-list ID
array
HighLevel Smart List IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Is draft
integer
required
Numeric Google Ads conversion action ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_DELETE_SEGMENTDelete a Google Ads audience segment by ID. 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

string ("CUSTOM_SEGMENTS" | "DATA_SEGMENTS")
required
Segment type
string
required
Numeric Google Ads segment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_GET_ASSETSRetrieve CALL or SITELINK Google Ads creative assets for a location. Location PITs must be provisioned with the HighLevel permission adPublishing.readonly.

Input Parameters

string
Numeric Google Ads asset ID
string ("CALL" | "SITELINK")
required
Live-supported asset type to retrieve.
string ("true" | "false")
Advertiser only flag

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_GET_AUDIENCE_BY_IDRetrieve a specific Google Ads combined audience by ID Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

boolean
Is draft
string
required
Numeric Google Ads audience ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_GET_AUDIENCESRetrieve Google Ads combined audiences for a location Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

boolean
Is draft

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_GET_CAMPAIGN_BY_IDRetrieve a specific Google Ads campaign by ID, including its ad groups and ad content. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

string
required
Ad identifier
boolean
Is draft

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_GET_CONVERSION_BY_IDRetrieve a specific Google Ads conversion action by ID Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

boolean
Is draft
integer
required
Numeric Google Ads conversion action ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_GET_CONVERSION_GOALSRetrieve Google Ads conversion goals for a location Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

boolean
Is draft

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("AD_MANAGER" | "AD_WORDS")
Google Ads integration type. Defaults to AD_MANAGER; use AD_WORDS only for a legacy AdWords connection.
integer
Page size for AD_MANAGER results (1-100). Supplying it enables the paginated response envelope.
string ("DEFAULT" | "PAGE_VIEW" | "PURCHASE" | "SIGNUP" | "LEAD" | "DOWNLOAD" | "ADD_TO_CART" | "BEGIN_CHECKOUT" | "SUBSCRIBE_PAID" | "PHONE_CALL_LEAD" | "IMPORTED_LEAD" | "SUBMIT_LEAD_FORM" | "BOOK_APPOINTMENT" | "REQUEST_QUOTE" | "GET_DIRECTIONS" | "OUTBOUND_CLICK" | "CONTACT" | "ENGAGEMENT" | "STORE_VISIT" | "STORE_SALE" | "QUALIFIED_LEAD" | "CONVERTED_LEAD")
Conversion category
string
Filter end date
string
Opaque paging.next token returned by the previous paginated AD_MANAGER call.
string
Filter start date
string ("UPLOAD_CLICKS" | "UPLOAD_CALLS" | "WEBPAGE" | "LEAD_FORM_SUBMIT" | "AD_CALL")
Optional conversion source filter for AD_MANAGER connections; ignored by legacy AD_WORDS connections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("AD_MANAGER" | "INTEGRATION")
required
Google connection path. Use AD_MANAGER for the current Google Ads integration; INTEGRATION is the legacy AdWords path.
string
Filter end date
string
Comma-separated numeric Google Ads IDs to retrieve.
string
Filter start date
string
Numeric Google Ads ad group ID (for example 9876543210), not a HighLevel ID. Use this or campaign_id when entity_type is AD.
string
Numeric Google Ads campaign ID (for example 1234567890), not a HighLevel draft campaign ID. Required when entity_type is ADGROUP; may also scope AD results.
string ("CAMPAIGN" | "ADGROUP" | "AD")
required
Entity type
string
Selected ad account ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Target URL
boolean
Is draft
array
Seed keywords
array
Numeric geo target IDs from the id field returned by SEARCH_AD_TARGETING, not geoTargetConstants resource names or country codes.
string
Google languageConstants resource name from the resourceName field returned by SEARCH_AD_TARGETING with type=language; a bare language code or numeric ID is rejected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_GET_SEGMENT_BY_IDRetrieve a specific Google Ads audience segment by ID Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

string ("CUSTOM_SEGMENTS" | "DATA_SEGMENTS")
required
Segment type
string
required
Numeric Google Ads segment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_GET_SEGMENTSRetrieve Google Ads audience segments for a location Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

string ("CUSTOM_SEGMENTS" | "DATA_SEGMENTS" | "ALL")
Segment type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("AFFINITY" | "IN_MARKET")
required
Interest type
string ("SEARCH" | "DISPLAY" | "SHOPPING" | "HOTEL" | "VIDEO" | "MULTI_CHANNEL" | "LOCAL" | "SMART" | "PERFORMANCE_MAX" | "LOCAL_SERVICES" | "DEMAND_GEN" | "TRAVEL")
required
Google Ads advertising channel type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_GOOGLE_PUBLISH_ADPublish a Google ad and push it live Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Ad identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("CALL" | "SITELINK")
required
Asset type to create or update
string
required
Type-specific CALL or SITELINK payload. For SITELINK updates, include resourceName.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Audience name
object
required
Required audience dimensions. A minimal live-proven value is a genders array.
string
Audience resource name
object
Exclusion dimensions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Campaign identifier
string
required
Campaign name
object
Campaign assets
object
Campaign budget
string
Traffic source
object
Campaign audience targeting
array
Campaign ad groups
string ("WEBSITE_TRAFFIC" | "LEAD")
Goal type
string
Read-only campaign creation timestamp.
string
Read-only campaign update timestamp.
array
Ad schedule rules
number
Maximum CPC bid in micros
object
Google campaign goal config, distinct from goal_type.
object
Advanced options
object
Bidding strategy config
object
Network settings
string ("DRAFT" | "SCHEDULED" | "PUBLISHED" | "PUBLISHING" | "FAILED" | "IN_REVIEW" | "PAUSED" | "ARCHIVED" | "WITH_ISSUES" | "REJECTED")
Publishing status
string
Google Ads campaign resource ID
boolean
EU political ads flag
boolean
Whether the campaign has unpublished changes
string
Google Ad account identifier
string ("SEARCH" | "DISCOVERY" | "DISPLAY" | "HOTEL" | "LOCAL" | "MULTI_CHANNEL" | "PERFORMANCE_MAX" | "DEMAND_GEN")
required
Advertising channel
string
Channel sub type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Conversion name
string
required
Conversion action type; HighLevel supports upload-click conversions
string ("DEFAULT" | "PAGE_VIEW" | "PURCHASE" | "SIGNUP" | "ADD_TO_CART" | "BEGIN_CHECKOUT" | "SUBSCRIBE_PAID" | "PHONE_CALL_LEAD" | "SUBMIT_LEAD_FORM" | "BOOK_APPOINTMENT" | "REQUEST_QUOTE" | "GET_DIRECTIONS" | "OUTBOUND_CLICK" | "CONTACT" | "ENGAGEMENT" | "QUALIFIED_LEAD" | "CONVERTED_LEAD")
required
Google Ads conversion action category. For lead tracking, use SUBMIT_LEAD_FORM or QUALIFIED_LEAD.
string
Numeric Google Ads conversion action ID to update. It is serialized as the string required by this endpoint. Omit it when creating.
string ("ONE_PER_CLICK" | "MANY_PER_CLICK")
required
How conversions are counted per interaction
object
required
Value settings that control how monetary value is attributed to conversions
string ("GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN" | "GOOGLE_ADS_LAST_CLICK")
required
Attribution model used to credit conversions
integer
required
Click-through conversion window from 1 to 90 days

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Segment identifier. Updates CUSTOM_SEGMENTS only. For CUSTOMER_MATCH and LOOKALIKE, HighLevel ignores this ID and every call creates a new list; LOOKALIKE lists cannot be deleted with DELETE_SEGMENT.
string
required
Segment name
string ("CUSTOM_SEGMENTS" | "WEBSITE_VISITOR" | "CUSTOMER_MATCH" | "LOOKALIKE")
required
Segment type
string ("ENABLED" | "REMOVED")
Segment status
array
Segment members — keywords, URLs, or apps that define the custom segment
string
Segment description
array
Country codes
string ("BALANCED" | "BROAD" | "NARROW")
Expansion level
string ("OPEN" | "CLOSED")
Membership status
array
Numeric seed user-list IDs
string ("AUTO" | "INTEREST" | "PURCHASE_INTENT" | "SEARCH")
Google custom-audience subtype for CUSTOM_SEGMENTS; defaults to AUTO when omitted.
number
Membership life span
object
Rule-based user list config

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Form name
object
required
Form owner
string
required
Form state
object
required
LinkedIn form content with questions, localized headline, legalInfo (consents and privacyPolicyUrl), and postSubmissionInfo.callToAction.callToActionLabel.
boolean
Is draft
string
required
Identifier required by the endpoint path (accountId).
array
Hidden fields
object
required
Creation locale

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_LI_GET_CAMPAIGN_GROUPRetrieve a LinkedIn ad campaign group by ID Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

string
required
Ad identifier
boolean
Is draft

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Reporting metrics to return. Supply a list containing one or more supported field names; the tool serializes the list for HighLevel.
string
required
End date in yyyy-mm-dd format
string
required
Start date in yyyy-mm-dd format
string
required
HighLevel MongoDB campaign-group ID (id), not LinkedIn’s numeric adCampaignGroupId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_LI_GET_LEAD_FORMSRetrieve LinkedIn lead gen forms for an ad account Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

boolean
Is draft
string
required
Account identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_LI_PUBLISH_CAMPAIGN_GROUPPublish a LinkedIn ad campaign group and push it live Location PITs must be provisioned with the HighLevel permission: adPublishing.write.

Input Parameters

string
required
Ad identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AD_PUBLISHING_LI_UPDATE_AD_STATUSPause, resume, or archive a LinkedIn ad, campaign, or ad group. Location PITs must be provisioned with the HighLevel permission adPublishing.write.

Input Parameters

string ("adGroup" | "adCampaign" | "ad")
required
Ad object type
string
required
Ad identifier
boolean
Is draft
string ("PAUSED" | "ARCHIVED" | "RESUME")
required
Update operation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
HighLevel MongoDB campaign-group ID. Use this internal id when updating an existing group; it is distinct from LinkedIn’s numeric adCampaignGroupId.
object
Additional metadata
string
Campaign group name. Required when creating a group without an existing HighLevel id.
object
Campaign group budget object with budgetType (DAILY or LIFETIME), amount, and optional scheduleStartDate and scheduleEndDate.
array
Child ad campaigns. Each campaign can include name, publishingStatus, unitCost, mediaType, ads, and audience. Audience geoLocations items use {name, urn, facetUrn, selectionType}; targetAudience.include is an array of arrays whose items use {urn, name, categoryName, facet}.
string ("LEAD_GENERATION" | "WEBSITE_VISIT")
Campaign group objective
string
LinkedIn API error message
string ("DRAFT" | "SCHEDULED" | "PUBLISHED" | "PUBLISHING" | "FAILED" | "IN_REVIEW" | "PAUSED" | "ARCHIVED" | "WITH_ISSUES" | "REJECTED")
Publishing status
boolean
Whether the campaign group has unpublished changes
string
LinkedIn’s numeric campaign group resource ID assigned after publication; this is not the HighLevel MongoDB id.
object
User-provided overrides for custom_values merge tags used in ad copy.
string ("MAXIMUM_DELIVERY" | "COST_CAP")
Ad budget optimization mode
string
LinkedIn ad account identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AFFILIATE_MANAGER_GET_AFFILIATERetrieve a single affiliate by id for a location. Location PITs must be provisioned with the HighLevel permission: affiliate-manager.readonly.

Input Parameters

string
required
Affiliate Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AFFILIATE_MANAGER_LIST_AFFILIATESRetrieve the list of affiliates for a location. Location PITs must be provisioned with the HighLevel permission: affiliate-manager.readonly.

Input Parameters

integer
Number of matching affiliates to skip.
integer
Maximum number of records to return. Maximum allowed value is 100.
string
Case-insensitive affiliate name or email search text.
string ("true" | "false")
Filter by active (true) or inactive (false) affiliates.
string
Opaque continuation cursor returned by the previous call.
string
Inclusive upper date bound in YYYY-MM-DD format.
string
Inclusive lower date bound in YYYY-MM-DD format.
string
Return affiliates assigned to this campaign ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AFFILIATE_MANAGER_LIST_COMMISSIONSRetrieve the list of commissions for a location. Location PITs must be provisioned with the HighLevel permission: affiliate-manager.readonly.

Input Parameters

integer
Number of matching commissions to skip.
integer
Maximum number of records to return. Maximum allowed value is 100.
string
Case-insensitive commission search text.
string
Opaque continuation cursor returned by the previous call.
string ("pending" | "approved" | "paid")
Commission status: pending, approved, or paid.
string
Inclusive upper date bound in YYYY-MM-DD format.
string
Inclusive lower date bound in YYYY-MM-DD format.
string
Return commissions attributed to this campaign ID.
string
Return commissions earned by this affiliate ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AFFILIATE_MANAGER_LIST_PAYOUTSRetrieve the list of payouts for a location. Location PITs must be provisioned with the HighLevel permission: affiliate-manager.readonly.

Input Parameters

string
Inclusive upper bound as YYYY-MM-DD or a timezone-qualified ISO 8601 date-time.
integer
Number of matching payouts to skip.
integer
Maximum payouts to return.
string
Case-insensitive payout search text.
string
Inclusive lower bound as YYYY-MM-DD or a timezone-qualified ISO 8601 date-time.
string
Opaque continuation cursor returned by the previous call.
string ("pending" | "paid")
Payout status: pending or paid.
string
Return payouts attributed to this campaign ID.
string
Return payouts for this affiliate ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AGENT_STUDIO_CREATE_AGENTCreate an Agent Studio agent with an initial staging version. Location PITs must be provisioned with the HighLevel permission: agent-studio.write.

Input Parameters

string
Name of the agent.
array
Deprecated top-level edge IDs; prefer version.edges.
array
Deprecated top-level node IDs; prefer version.nodes.
string
Optional provider source identifier.
string ("active" | "inactive" | "archived")
required
Initial status of the agent.
object
required
Initial staging version, including its nodes, edges, variables, and configuration.
string
Agency ID associated with the agent.
string
ID of the agent author.
string
Name of the agent author.
string
Description of the agent.
string
Location ID injected from the connected account; callers should omit it.
string
Email address of the agent author.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AGENT_STUDIO_DELETE_AGENTPermanently delete an Agent Studio agent and all of its versions. Location PITs must be provisioned with the HighLevel permission: agent-studio.write.

Input Parameters

string
Optional provider source identifier.
string
required
Agent ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional provider source identifier.
string
required
Message to send to the agent.
string
required
Active agent ID to execute.
string
Contact ID whose data should be hydrated for this execution.
string
Published version ID; omit to use the latest production version.
array
Message attachments, each with a type and imageUrl.
string
Location ID injected from the connected account; callers should omit it.
string
Prior execution ID to continue a conversation; omit for the first message.
object
Input variables matching the agent configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AGENT_STUDIO_GET_AGENT_BY_IDGet one active Agent Studio agent and all of its non-deleted versions. Location PITs must be provisioned with the HighLevel permission: agent-studio.readonly.

Input Parameters

string
Optional provider source identifier.
string
required
Agent ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AGENT_STUDIO_GET_AGENTSList active Agent Studio agents for the connected Location, one page at a time. Location PITs must be provisioned with the HighLevel permission: agent-studio.readonly.

Input Parameters

integer
Number of agents to return on this page.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
integer
Zero-based starting offset for the first page.
string
Optional provider source identifier.
boolean
Set to true to return only agents with a published production version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AGENT_STUDIO_PROMOTE_AND_PUBLISHIrreversibly promote an Agent Studio draft version to production. Location PITs must be provisioned with the HighLevel permission: agent-studio.write.

Input Parameters

string
Optional provider source identifier.
string
ID of the user performing the promotion.
string
Name of the user performing the promotion.
string
Email of the user performing the promotion.
string
required
Draft version ID to promote to production.
string
Location ID injected from the connected account; callers should omit it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_AGENT_STUDIO_UPDATE_AGENT_METADATAUpdate an Agent Studio agent’s name, description, or status. Location PITs must be provisioned with the HighLevel permission: agent-studio.write.

Input Parameters

string
New agent name.
string
Optional provider source identifier.
string ("active" | "inactive" | "archived")
New agent status.
string
required
Agent ID to update.
string
New agent description.
string
Location ID injected from the connected account; callers should omit it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Do not send: HighLevel currently wipes edge contents and stores empty shells when this field is patched.
array
Do not send: HighLevel currently wipes node contents and stores empty shells when this field is patched.
string
Optional provider source identifier.
string
ID of the user performing the update.
string
Name of the user performing the update.
string
required
Version ID to update.
string
New version description.
string
Location ID injected from the connected account; callers should omit it.
string
New version name.
object
Global prompts and workflow settings.
array
Do not send: HighLevel currently wipes variable contents and stores empty shells when this field is patched.
array
Do not send: HighLevel currently wipes variable contents and stores empty shells when this field is patched.
array
Do not send: HighLevel currently wipes variable contents and stores empty shells when this field is patched.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_ASSOCIATIONS_CREATE_ASSOCIATIONCreate a user-defined association between supported HighLevel object types. Location PITs must be provisioned with the HighLevel permission: associations.write.

Input Parameters

string
required
Unique association key.
string
Connected HighLevel Location ID.
string
required
Key configuration for the first object.
string
required
Key configuration for the second object.
string
required
Label configuration for the first object.
string
required
Label configuration for the second object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Connected HighLevel Location ID.
string
required
ID of the association definition.
string
required
ID of the record for the association’s first object.
string
required
ID of the record for the association’s second object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
User-defined association ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_ASSOCIATIONS_DELETE_RELATIONPermanently delete one relation between associated records. Location PITs must be provisioned with the HighLevel permission: associations/relation.write.

Input Parameters

string
required
Relation ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_ASSOCIATIONS_FIND_ASSOCIATIONSReturn a page of association definitions for the connected Location. Location PITs must be provisioned with the HighLevel permission: associations.readonly.

Input Parameters

integer
Number of associations to skip.
integer
Maximum associations to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_ASSOCIATIONS_GET_ASSOCIATION_BY_IDGet a system- or user-defined association by its ID. Location PITs must be provisioned with the HighLevel permission: associations.readonly.

Input Parameters

string
required
System- or user-defined association ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_ASSOCIATIONS_GET_ASSOCIATION_BY_OBJECT_KEYSGet association definitions for a contact, opportunity, or custom-object key. Location PITs must be provisioned with the HighLevel permission: associations.readonly.

Input Parameters

string
required
Object key whose association definitions to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_ASSOCIATIONS_GET_ASSOCIATION_KEY_BY_KEY_NAMEGet a standard or user-defined association definition by its key name. Location PITs must be provisioned with the HighLevel permission: associations.readonly.

Input Parameters

string
required
Standard or user-defined association key name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of relations to skip.
integer
Maximum relations to return.
string
required
Record ID whose relations to return.
array
Optional association definition IDs to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_ASSOCIATIONS_UPDATE_ASSOCIATIONUpdate the first- and second-object labels of an association definition. Location PITs must be provisioned with the HighLevel permission: associations.write.

Input Parameters

string
required
Association definition ID to update.
string
required
Updated label configuration for the first object.
string
required
Updated label for the second object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BLOGS_CHECK_URL_SLUG_EXISTSCheck whether a URL slug is already used by a blog post in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: blogs/check-slug.readonly.

Input Parameters

string
Existing blog post ID to exclude when checking an edited post.
string
required
URL slug to check before publishing a blog post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BLOGS_CREATE_BLOG_POSTCreate a blog post in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: blogs/post.write.

Input Parameters

array
Optional tags for the post.
string
required
Blog post title.
string
required
Author ID returned by the blog authors endpoint.
string ("DRAFT" | "PUBLISHED" | "SCHEDULED" | "ARCHIVED")
required
Publication status for the blog post.
string
required
Blog ID from the blog site dashboard.
string
required
HTML content of the blog post.
string
required
URL slug for the blog post.
string
required
Direct URL of the blog post image; use a URL ending in an image file extension.
array
required
Category IDs to associate with the post.
string
required
Short description of the blog post.
string
required
Publication timestamp in ISO 8601 format with a timezone offset.
Optional canonical URL for the blog post.
string
required
Alternative text for the blog post image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BLOGS_GET_ALL_BLOG_AUTHORS_BY_LOCATIONReturn one offset-based page of blog authors for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: blogs/author.readonly.

Input Parameters

integer
required
Number of authors to return.
integer
required
Number of authors to skip.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BLOGS_GET_ALL_CATEGORIES_BY_LOCATIONReturn one offset-based page of blog categories for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: blogs/category.readonly.

Input Parameters

integer
required
Number of categories to return.
integer
required
Number of categories to skip.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BLOGS_GET_BLOG_POSTReturn one offset-based page of posts for a blog in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: blogs/posts.readonly.

Input Parameters

integer
required
Number of posts to return (1-50).
integer
required
Number of posts to skip.
string ("ALL" | "PUBLISHED" | "SCHEDULED" | "SCHEDULE_FAILED" | "ARCHIVED" | "DELETED" | "DRAFT")
Optional publication status filter.
string
required
Blog ID whose posts to return.
string
Optional post title search term.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BLOGS_GET_BLOGSReturn one offset-based page of blogs for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: blogs/list.readonly.

Input Parameters

integer
required
Number of blogs to skip.
integer
required
Number of blogs to return.
string
Optional blog name search term.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BLOGS_UPDATE_BLOG_POSTUpdate an existing blog post in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: blogs/post-update.write.

Input Parameters

array
Optional tags for the post.
string
required
Blog post title.
string
required
Author ID returned by the blog authors endpoint.
string ("DRAFT" | "PUBLISHED" | "SCHEDULED" | "ARCHIVED")
required
Publication status for the blog post.
string
required
Blog ID from the blog site dashboard.
string
required
Blog post ID to update.
string
required
HTML content of the blog post.
string
required
URL slug for the blog post.
string
required
URL of the blog post image.
array
required
Category IDs to associate with the post.
number
required
Word count for the blog post.
string
required
Short description of the blog post.
string
required
Publication timestamp in ISO 8601 format with a timezone offset.
Optional canonical URL for the blog post.
string
required
Alternative text for the blog post image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BRAND_BOARDS_CREATE_BRAND_BOARDCreate a brand board with logos, colors, and fonts in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: brand-boards/design-kit.write.

Input Parameters

string
Website URL from which to extract design assets.
string
required
Brand board name.
string ("template" | "blank" | "snapshot" | "url")
How the brand board is sourced.
array
Brand fonts.
array
Brand logos.
array
Brand colors.
boolean
Whether to make this the default brand board.
string
Parent media folder ID.
string
Source brand board ID to copy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BRAND_BOARDS_CREATE_BRAND_VOICECreate a brand voice in the connected location. Location PITs require brand-boards/voices.write.

Input Parameters

string
Website URL; required for type ‘url’.
string
Brand voice name.
string ("manual" | "url" | "description")
required
Creation source.
object
Answers; required for type ‘manual’.
string
Company description; required for type ‘description’ and must contain at least 50 words.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BRAND_BOARDS_DELETE_BRAND_BOARDDelete a brand board from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: brand-boards/design-kit.write.

Input Parameters

string
required
Brand board ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BRAND_BOARDS_DELETE_BRAND_VOICEDelete a brand voice after explicit confirmation. Location PITs require brand-boards/voices.write.

Input Parameters

string
required
Brand voice ID.
boolean
required
Must be true to confirm this destructive or business-affecting change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BRAND_BOARDS_GET_BRAND_BOARD_BY_IDRetrieve one brand board by ID from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: brand-boards/design-kit.readonly.

Input Parameters

string
required
Brand board ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BRAND_BOARDS_GET_BRAND_BOARDS_BY_LOCATIONReturn one page of brand boards for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: brand-boards/design-kit.readonly.

Input Parameters

integer
Maximum brand boards to return.
string
Opaque continuation cursor returned by the previous call.
integer
Number of brand boards to skip.
Search term for brand board names.
boolean
Whether to include deleted brand boards.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BRAND_BOARDS_GET_BRAND_VOICEGet a brand voice from the connected location. Location PITs require brand-boards/voices.readonly.

Input Parameters

string
required
Brand voice ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BRAND_BOARDS_LIST_BRAND_VOICESReturn one page of brand voices for the connected location. Location PITs require brand-boards/voices.readonly.

Input Parameters

integer
Maximum voices to return.
integer
Offset returned by a previous call.
integer
Number of voices to skip.
string
Brand voice name search text.
boolean
Whether to include deleted voices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BRAND_BOARDS_SET_DEFAULT_BRAND_VOICESet the location’s default brand voice, replacing the previous default, after explicit confirmation. Location PITs require brand-boards/voices.write.

Input Parameters

string
required
Brand voice ID.
boolean
required
Must be true to confirm this destructive or business-affecting change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BRAND_BOARDS_UPDATE_BRAND_BOARDUpdate an existing brand board in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: brand-boards/design-kit.write.

Input Parameters

string
required
Brand board ID.
string
Updated brand board name.
array
Replacement brand fonts.
array
Replacement brand logos.
array
Replacement brand colors.
boolean
Whether to make this the default brand board.
string
Parent media folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BRAND_BOARDS_UPDATE_BRAND_VOICEUpdate a brand voice after explicit confirmation. Location PITs require brand-boards/voices.write.

Input Parameters

string
Updated brand voice name.
object
Complete replacement set of brand voice answers; omitted answer fields are removed.
string
required
Brand voice ID.
boolean
required
Must be true to confirm changing this brand voice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BUSINESSES_CREATE_BUSINESSCreate a business in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: businesses.write.

Input Parameters

string
Business city.
string
required
Business name.
string
Business email address.
string
Business phone number.
string
Business state or region.
string
Business street address.
string
Business country.
string
Business website.
string
Description of the business.
string
Business postal code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BUSINESSES_DELETE_BUSINESSPermanently delete a business by ID. Location PITs must be provisioned with the HighLevel permission: businesses.write.

Input Parameters

string
required
ID of the business to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BUSINESSES_GET_BUSINESSRetrieve one business by ID. Location PITs must be provisioned with the HighLevel permission: businesses.readonly.

Input Parameters

string
required
ID of the business to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BUSINESSES_GET_BUSINESSES_BY_LOCATIONReturn one offset-paginated page of businesses for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: businesses.readonly.

Input Parameters

integer
Zero-based result offset for the first page.
integer
Number of businesses to return per page.
string
Opaque continuation cursor returned by the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_BUSINESSES_UPDATE_BUSINESSUpdate editable details of an existing business by ID. Location PITs must be provisioned with the HighLevel permission: businesses.write.

Input Parameters

string
Business city.
string
Business name.
string
Business email address.
string
Business phone number.
string
Business state or region.
string
Business street address.
string
Business country.
string
Business website.
string
required
ID of the business to update.
string
Description of the business.
string
Business postal code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_ADD_CALENDAR_TO_SCHEDULEAssociate a calendar with a schedule. HighLevel may create an unnamed cloned schedule while changing the association. Location PITs must be provisioned with the HighLevel permission: calendars.write.

Input Parameters

string
required
Unique identifier of the schedule
string
required
Unique identifier of the team calendar to add to the schedule

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
RRULE as per the iCalendar (RFC 5545) specification for recurring events. DTSTART is not required, instance ids are calculated on the basis of startTime of the event. The rrule only be applied if ignoreFreeSlotValidation is true.
string
Title
string
Appointment Address
string
End Time
boolean
If set to false, the automations will not run. Defaults to true
string
required
Contact Id
string
required
Start Time
string
required
Calendar Id
string
Appointment Description
string
Location ID supplied by the connected account; caller values are overwritten.
string
Assigned User Id
boolean
If set to true, the minimum scheduling notice and date range would be ignored
string ("new" | "confirmed" | "cancelled" | "showed" | "noshow" | "invalid" | "completed" | "active")
Initial appointment status, such as confirmed, cancelled, or completed.
string
The unique identifier for the meeting location. - This value can be found in calendar.locationConfigurationsor calendar.teamMembers[].locationConfigurations
string ("custom" | "zoom" | "gmeet" | "phone" | "address" | "ms_teams" | "google")
Meeting location type. - If address is provided in the request body, the meetingLocationType defaults to custom.
boolean
Flag to override location config - false - If only meetingLocationId is provided - true - If only meetingLocationType is provided
boolean
If true the time slot validation would be avoided for any appointment creation (even the ignoreDateRange)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Note body
string
HighLevel user ID to attribute as the note’s author.
string
required
Appointment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_CREATE_BLOCK_SLOTCreate a block slot for exactly one owner: assigned_user_id or calendar_id. Location PITs must be provisioned with the HighLevel permission: calendars/events.write.

Input Parameters

string
Title
string
required
End time as ISO 8601 with a timezone offset.
string
required
Start time as ISO 8601 with a timezone offset.
string
Either calendarId or assignedUserId can be set, not both.
string
Location ID supplied by the connected account; caller values are overwritten.
string
Either calendarId or assignedUserId can be set, not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_CREATE_CALENDARCreate calendar in a location. Location PITs must be provisioned with the HighLevel permission: calendars.write.

Input Parameters

string
required
Display name of the calendar.
string
URL-friendly identifier for the calendar.
string
Internal notes associated with the calendar.
string
ID of the form used to collect booking details.
string
Group Id
string
Tracking pixel ID used on the booking page.
boolean
Should the created calendar be active or draft
object
Recurring booking frequency and conflict settings.
string ("RoundRobin_OptimizeForAvailability" | "RoundRobin_OptimizeForEqualDistribution")
Round-robin scheduling optimization strategy.
string ("count_only" | "collect_detail")
Whether to count guests only or collect their details.
array
Legacy availability hours. Each item must contain exactly one weekday (0=Sunday through 6=Saturday); repeat items for several days. Prefer the Availability APIs for new integrations.
number
Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
string
Email address that receives booking alerts.
string
Description of the calendar shown to bookers.
string
Color used to display calendar events.
string
Title used for events created from bookings.
string
Location ID supplied by the connected account; caller values are overwritten.
number
Slot-Buffer is additional time that can be added after an appointment, allowing for extra time to wrap up
string
URL slug for the calendar’s booking widget.
string ("default" | "classic")
Calendar widget type. Choose “default” for “neo” and “classic” for “classic” layout.
boolean
Automatically confirm new bookings.
array
Team members are required for calendars of type: Round Robin, Collective, Class, Service. Personal calendar must have exactly one team member.
string ("round_robin" | "event" | "class_booking" | "collective" | "service_booking" | "personal")
Booking and assignment model for the calendar.
Consent text displayed on the booking form.
array
Deprecated! Please use ‘Calendar Notifications APIs’ instead.
number
This controls the duration of the meeting
number
Slot interval reflects the amount of time the between booking slots that will be shown in the calendar.
array
While we will support this property for backward compatibility, it is recommended to use ‘Availability’ APIs instead.
boolean
Keep a contact assigned to the same team member across bookings.
string ("mins" | "hours")
Unit for pre-buffer.
boolean
Allow bookers to reschedule appointments.
boolean
Enable recurring appointments for the calendars. Please note that only one member should be added in the calendar to enable this
string ("RedirectURL" | "ThankYouMessage")
Action shown after a booking form is submitted.
object
Look Busy Configuration
string
Deprecated! Use locationConfigurations.location or teamMembers[].locationConfigurations.location instead.
string ("mins" | "hours")
Unit for slot buffer.
number
Minimum number of days/weeks/months for which to allow booking events
integer ("0" | "1")
While we will support this property for backward compatibility, it is not required anymore.
boolean
Allow bookers to cancel appointments.
number
Number of appointments that can be booked for a given day
string ("mins" | "hours")
Unit for slot duration.
string ("mins" | "hours")
Unit for slot interval.
number
Minimum scheduling notice for events
number
Maximum bookings per slot (per user). Maximum seats per slot in case of Class Booking Calendar.
string
URL of the calendar cover image.
boolean
Use live payment processing instead of test mode.
string ("days" | "weeks" | "months")
Unit for controlling the duration for which booking would be allowed for
array
Meeting location configuration for event calendar
string ("hours" | "days" | "weeks" | "months" | "mins")
Unit for minimum scheduling notice
string
URL to open after form submission when redirecting.
boolean
Send Google Calendar invitation emails for bookings.
string
Thank-you message shown after form submission.
boolean
Assign the booked contact to the selected team member.
boolean
Preserve the current assignment for existing contacts.
boolean
Send booking alert emails to the assigned team member.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_CREATE_CALENDAR_GROUPCreate Calendar Group Location PITs must be provisioned with the HighLevel permission: calendars/groups.write.

Input Parameters

string
required
Display name of the calendar group.
string
required
URL-friendly identifier for the calendar group. Use VALIDATE_GROUPS_SLUG before creation to check availability.
boolean
Whether the calendar group is active.
string
required
Description of the calendar group.
string
Location ID supplied by the connected account; caller values are overwritten.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Display name of the room or equipment resource.
number
required
Capacity of the room.
number
required
Quantity of the equipment.
string
required
Description of the room or equipment resource.
string
Location ID supplied by the connected account; caller values are overwritten.
array
required
Service calendar IDs to be mapped with the resource. One equipment can only be mapped with one service calendar. One room can be mapped with multiple service calendars.
string ("equipments" | "rooms")
required
Calendar Resource Type
number
required
Quantity of the out of service equipment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Schedule rules defining when the schedule is active
string
required
Timezone for the schedule (IANA timezone identifier)
string
required
Unique identifier of the event calendar

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_CREATE_EVENT_NOTIFICATIONCreate Calendar notifications, either one or multiple. All notification settings must be for single calendar only Location PITs must be provisioned with the HighLevel permission: calendars/events.write.

Input Parameters

array
required
One or more notification settings to create for the calendar.
string
required
Calendar that will receive these notification settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Human-readable name for the schedule
array
required
Schedule rules defining when the schedule is active; HighLevel requires an array and accepts an empty list.
string
required
User ID associated with the schedule
string
required
Timezone for the schedule (IANA timezone identifier)
string
Location ID supplied by the connected account; caller values are overwritten.
array
Calendar IDs associated with the schedule

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_CREATE_SERVICE_BOOKINGCreate a new service booking Location PITs must be provisioned with the HighLevel permission: calendars/events.write.

Input Parameters

string
Service Booking Title
string ("confirmed" | "new")
Status. (If not provided, the status configured in Service Global Settings will be used.)
string
required
End time as ISO 8601 with a timezone offset.
array
required
At least one service to book.
string
required
Timezone
string
required
Contact ID
string
required
Start time as ISO 8601 with a timezone offset.
string
Location ID supplied by the connected account; caller values are overwritten.
string
Meeting Location (If service location is an ask the booker, then the meeting location is required)
string
Service Location ID (If not provided, then the default service location will be used)
boolean
If true the time slot validation would be avoided for any booking creation/update (even the skipSchedulingNotice)
boolean
If set to true, the minimum scheduling notice and date range would be ignored

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_CREATE_SERVICE_CATALOGCreate new service in a location. Location PITs must be provisioned with the HighLevel permission: calendars.write.

Input Parameters

string
required
Service name
string
required
Unique URL-friendly identifier
array
required
Assigned staff members (at least one required)
string
Custom form ID (will be used to display the custom form on the booking page, if only one service is selected)
object
Payment details (default amount is 0, currency configured in Service Global Settings is used.)
boolean
Whether service is private (not shown publicly)
number
Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
array
Service variations (pass empty array for no variations)
string
Service cover image URL
string
Service description
string
Service event color (hex)
string
Location ID supplied by the connected account; caller values are overwritten.
number
Post-buffer: Additional time that can be added after an appointment, allowing for extra time to wrap up
string ("mins" | "hours")
Pre-buffer unit
string ("mins" | "hours")
Post-buffer unit
number
This controls the duration of the appointment
string
Service category ID (uses default category if not provided)
string ("mins" | "hours")
Duration unit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_CREATE_SERVICE_LOCATIONCreate a new service location Location PITs must be provisioned with the HighLevel permission: calendars.write.

Input Parameters

string
required
Location name
string
required
URL-friendly slug identifier
string
Phone number
string
Use a full street address when locationType is offline. Use a user-facing label when locationType is ask_booker.
string
URL of the cover image for this service location
string
Location ID supplied by the connected account; caller values are overwritten.
string ("offline" | "ask_booker")
Location type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_DELETE_APPOINTMENT_NOTEDelete an appointment note by appointment ID and note ID. Location PITs must be provisioned with the HighLevel permission calendars/events.write.

Input Parameters

string
required
Appointment note to delete.
string
required
Appointment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_DELETE_CALENDARDelete calendar by ID Location PITs must be provisioned with the HighLevel permission: calendars.write.

Input Parameters

string
required
Calendar Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_DELETE_CALENDAR_RESOURCEDelete calendar resource by ID (Services V1) Location PITs must be provisioned with the HighLevel permission: calendars/resources.write.

Input Parameters

string
required
Calendar Resource ID
string ("equipments" | "rooms")
required
Calendar Resource Type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_DELETE_EVENTDelete event by ID Location PITs must be provisioned with the HighLevel permission: calendars/events.write.

Input Parameters

string
required
Event Id or Instance id. For recurring appointments send masterEventId to modify original series.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_DELETE_EVENT_NOTIFICATIONDelete a calendar notification setting by calendar ID and notification ID. Location PITs must be provisioned with the HighLevel permission calendars/events.write.

Input Parameters

string
required
Calendar that owns the notification setting.
string
required
Notification setting to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_DELETE_GROUPDelete a calendar group by ID. Location PITs must be provisioned with the HighLevel permission calendars/groups.write.

Input Parameters

string
required
Group Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_DELETE_SCHEDULEPermanently remove a schedule and all its associated rules. This action cannot be undone. Location PITs must be provisioned with the HighLevel permission: calendars.write.

Input Parameters

string
required
Unique identifier of the schedule to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_DELETE_SERVICE_BOOKINGDelete a service booking by ID Location PITs must be provisioned with the HighLevel permission: calendars/events.write.

Input Parameters

string
required
Unique Service Booking ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Service ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_DELETE_SERVICE_LOCATIONDelete a service location by ID Location PITs must be provisioned with the HighLevel permission: calendars.write.

Input Parameters

string
required
Unique Service Location ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_DISABLE_GROUPUpdate a calendar group’s active status by ID, enabling or disabling it. Location PITs must be provisioned with the HighLevel permission calendars/groups.write.

Input Parameters

string
required
Group Id
boolean
required
Is Active?

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_EDIT_APPOINTMENTUpdate appointment Location PITs must be provisioned with the HighLevel permission: calendars/events.write.

Input Parameters

string
RRULE as per the iCalendar (RFC 5545) specification for recurring events. DTSTART is not required, instance ids are calculated on the basis of startTime of the event. The rrule only be applied if ignoreFreeSlotValidation is true.
string
Title
string
Appointment Address
string
End Time
string
required
Event Id or Instance id. For recurring appointments send masterEventId to modify original series.
boolean
If set to false, the automations will not run. Defaults to true
string
Start Time
string
Calendar Id
string
Appointment Description
string
Assigned User Id
boolean
If set to true, the minimum scheduling notice and date range would be ignored
string ("new" | "confirmed" | "cancelled" | "showed" | "noshow" | "invalid" | "completed" | "active")
New appointment status, such as confirmed, cancelled, or completed.
string
The unique identifier for the meeting location. - This value can be found in calendar.locationConfigurationsor calendar.teamMembers[].locationConfigurations
string ("custom" | "zoom" | "gmeet" | "phone" | "address" | "ms_teams" | "google")
Meeting location type. - If address is provided in the request body, the meetingLocationType defaults to custom.
boolean
Flag to override location config - false - If only meetingLocationId is provided - true - If only meetingLocationType is provided
boolean
If true the time slot validation would be avoided for any appointment creation (even the ignoreDateRange)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_EDIT_BLOCK_SLOTUpdate block slot by ID Location PITs must be provisioned with the HighLevel permission: calendars/events.write.

Input Parameters

string
Title
string
End Time
string
required
Event Id or Instance id. For recurring appointments send masterEventId to modify original series.
string
Start Time
string
Either calendarId or assignedUserId can be set, not both.
string
Location ID supplied by the connected account; caller values are overwritten.
string
Either calendarId or assignedUserId can be set, not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_EDIT_GROUPUpdate Group by group ID Location PITs must be provisioned with the HighLevel permission: calendars/groups.write.

Input Parameters

string
required
Display name of the calendar group.
string
required
URL-friendly identifier for the calendar group. Use VALIDATE_GROUPS_SLUG before changing it because HighLevel accepts duplicate slugs.
string
required
Group Id
string
required
Description of the calendar group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_FETCH_CALENDAR_RESOURCESList calendar resources by resource type and location ID (Services V1) Location PITs must be provisioned with the HighLevel permission: calendars/resources.readonly.

Input Parameters

integer
Number of calendar resources to skip.
integer
Maximum calendar resources to return.
string
Continuation cursor returned by the previous call.
string ("equipments" | "rooms")
required
Calendar Resource Type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_FIND_EVENT_NOTIFICATIONGet an event notification setting by calendar ID and notification ID. Location PITs must be provisioned with the HighLevel permission calendars/events.readonly.

Input Parameters

string
required
Calendar that owns the notification setting.
string
required
Notification setting to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_ALL_SCHEDULESRetrieve paginated availability schedules for a required user in the connected location, optionally filtered by calendar. Location PITs must be provisioned with the HighLevel permission calendars.readonly.

Input Parameters

integer
Number of items to skip for pagination
integer
Maximum number of items to return (max 499)
string
Continuation cursor returned by the previous call.
string
required
User ID to filter schedules by specific user
string
Calendar ID for filtering schedules by specific calendar

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_APPOINTMENTGet appointment by ID Location PITs must be provisioned with the HighLevel permission: calendars/events.readonly.

Input Parameters

string
required
Event Id or Instance id. For recurring appointments send masterEventId to modify original series.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_APPOINTMENT_NOTESGet Appointment Notes Location PITs must be provisioned with the HighLevel permission: calendars/events.readonly.

Input Parameters

integer
Limit of notes to fetch
string
Continuation cursor returned by the previous call.
integer
Offset of notes to fetch
string
required
Appointment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_BLOCKED_SLOTSGet blocked slots for exactly one owner: user_id, calendar_id, or group_id. Location PITs must be provisioned with the HighLevel permission: calendars/events.readonly.

Input Parameters

string
User Id - Owner of an appointment. Either of userId, groupId or calendarId is required
string
required
End Time (in millis)
string
Either of groupId, calendarId or userId is required
string
required
Start Time (in millis)
string
Either of calendarId, userId or groupId is required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_CALENDARGet calendar by ID Location PITs must be provisioned with the HighLevel permission: calendars.readonly.

Input Parameters

string
required
Calendar Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_CALENDAR_EVENTSGet calendar events for exactly one owner: user_id, calendar_id, or group_id. Location PITs must be provisioned with the HighLevel permission: calendars/events.readonly.

Input Parameters

string
User Id - Owner of an appointment. Either of userId, groupId or calendarId is required
string
required
End Time (in millis)
string
Either of groupId, calendarId or userId is required
string
required
Start Time (in millis)
string
Either of calendarId, userId or groupId is required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_CALENDAR_RESOURCEGet calendar resource by ID (Services V1) Location PITs must be provisioned with the HighLevel permission: calendars/resources.readonly.

Input Parameters

string
required
Calendar Resource ID
string ("equipments" | "rooms")
required
Calendar Resource Type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_CALENDARSGet all calendars in a location. Location PITs must be provisioned with the HighLevel permission: calendars.readonly.

Input Parameters

string
Group Id
boolean
Show drafted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the event calendar

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of records to skip
integer
Number of records to return
string
Continuation cursor returned by the previous call.
boolean
Filter notification settings by soft-deleted status.
boolean
Filter notification settings by active status.
string
required
Calendar whose notification settings to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_GROUPSGet all calendar groups in a location. Location PITs must be provisioned with the HighLevel permission: calendars/groups.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the schedule

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_SERVICE_BOOKING_BY_IDGet a specific service booking by ID Location PITs must be provisioned with the HighLevel permission: calendars/events.readonly.

Input Parameters

string
required
Unique Service Booking ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_SERVICE_BOOKINGSRetrieve service bookings for a location within a given date range, with an optional service location filter. Location PITs must be provisioned with the HighLevel permission: calendars/events.readonly.

Input Parameters

string
required
End Time (timestamp in milliseconds as string)
string
Timezone
string
required
Start Time (timestamp in milliseconds as string)
string
Service Location ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_SERVICE_CATALOG_BY_IDGet service by ID. Location PITs must be provisioned with the HighLevel permission: calendars.readonly.

Input Parameters

string
required
Service ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_SERVICE_LOCATION_BY_IDGet service location by ID Location PITs must be provisioned with the HighLevel permission: calendars.readonly.

Input Parameters

string
required
Unique Service Location ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_SERVICE_LOCATIONSGet all service locations Location PITs must be provisioned with the HighLevel permission: calendars.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_GET_SERVICES_CATALOGGet all services in a location. Location PITs must be provisioned with the HighLevel permission: calendars.readonly.

Input Parameters

boolean
Filter services: true = private only, false = public only, unset = all services
string
Filter by service category ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The user for whom the free slots are returned
number
required
End Date (** Important:** Date range cannot be more than 31 days)
string
The timezone in which the free slots are returned
array
The users for whom the free slots are returned
number
required
Start Date (** Important:** Date range cannot be more than 31 days)
string
required
Calendar Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_REMOVE_CALENDAR_FROM_SCHEDULERemove a calendar from a schedule. HighLevel may leave an unnamed cloned schedule after changing the association. Location PITs must be provisioned with the HighLevel permission: calendars.write.

Input Parameters

string
required
Unique identifier of the schedule
string
required
Unique identifier of the calendar to remove from the schedule

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_UPDATE_APPOINTMENT_NOTEUpdate Note Location PITs must be provisioned with the HighLevel permission: calendars/events.write.

Input Parameters

string
required
Note body
string
required
Appointment note to update.
string
HighLevel user ID to attribute as the note’s author.
string
required
Appointment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Display name of the calendar.
string
URL-friendly identifier for the calendar.
string
Internal notes associated with the calendar.
string
ID of the form used to collect booking details.
string
Group Id
string
Tracking pixel ID used on the booking page.
boolean
Whether the calendar is active and available for booking.
object
Recurring booking frequency and conflict settings.
string ("RoundRobin_OptimizeForAvailability" | "RoundRobin_OptimizeForEqualDistribution")
Round-robin scheduling optimization strategy.
string ("count_only" | "collect_detail")
Whether to count guests only or collect their details.
array
Legacy availability hours. Each item must contain exactly one weekday (0=Sunday through 6=Saturday); repeat items for several days. Prefer the Availability APIs for new integrations.
number
Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
string
Email address that receives booking alerts.
string
required
Calendar Id
string
Description of the calendar shown to bookers.
string
Color used to display calendar events.
string
Title used for events created from bookings.
number
Slot-Buffer is additional time that can be added after an appointment, allowing for extra time to wrap up
string
URL slug for the calendar’s booking widget.
string ("default" | "classic")
Calendar widget type. Choose “default” for “neo” and “classic” for “classic” layout.
boolean
Automatically confirm new bookings.
array
Team members are required for calendars of type: Round Robin, Collective, Class, Service. Personal calendar must have exactly one team member.
Consent text displayed on the booking form.
array
Deprecated! Please use ‘Calendar Notifications APIs’ instead.
number
This controls the duration of the meeting
number
Slot interval reflects the amount of time the between booking slots that will be shown in the calendar.
array
While we will support this property for backward compatibility, it is recommended to use ‘Availability’ APIs instead.
boolean
Keep a contact assigned to the same team member across bookings.
string ("mins" | "hours")
Unit for pre-buffer.
boolean
Allow bookers to reschedule appointments.
boolean
Enable recurring appointments for the calendars. Please note that only one member should be added in the calendar to enable this
string ("RedirectURL" | "ThankYouMessage")
Action shown after a booking form is submitted.
object
Look Busy Configuration
string
Deprecated! Use locationConfigurations.location or teamMembers[].locationConfigurations.location instead.
number
Minimum number of days/weeks/months for which to allow booking events
integer ("0" | "1")
While we will support this property for backward compatibility, it is not required anymore.
boolean
Allow bookers to cancel appointments.
number
Number of appointments that can be booked for a given day
string ("mins" | "hours")
Unit for slot duration.
string ("mins" | "hours")
Unit for slot interval.
number
Minimum scheduling notice for events
number
Maximum number of appointments allowed per time slot.
string
URL of the calendar cover image.
boolean
Use live payment processing instead of test mode.
string ("days" | "weeks" | "months")
Unit for controlling the duration for which booking would be allowed for
array
Meeting location configuration for event calendar
string ("hours" | "days" | "weeks" | "months" | "mins")
Unit for minimum scheduling notice
string
URL to open after form submission when redirecting.
boolean
Send Google Calendar invitation emails for bookings.
string
Thank-you message shown after form submission.
boolean
Assign the booked contact to the selected team member.
boolean
Preserve the current assignment for existing contacts.
boolean
Send booking alert emails to the assigned team member.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Calendar Resource ID
string
New display name of the room or equipment resource.
number
Capacity of the room.
number
Quantity of the equipment.
boolean
Whether the room or equipment is available for booking.
string
New description of the room or equipment resource.
string
Location ID supplied by the connected account; caller values are overwritten.
array
Service calendar IDs to be mapped with the resource. One equipment can only be mapped with one service calendar. One room can be mapped with multiple service calendars.
string ("equipments" | "rooms")
required
Calendar Resource Type
number
Quantity of the out of service equipment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Updated schedule rules defining when the schedule is active
string
Updated timezone for the schedule (IANA timezone identifier)
string
required
Unique identifier of the event calendar

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_UPDATE_EVENT_NOTIFICATIONUpdate Event notification by id Location PITs must be provisioned with the HighLevel permission: calendars/events.write.

Input Parameters

string
Body for email notification. Not necessary for in-App notification
string ("email" | "inApp" | "sms" | "whatsapp")
Notification channel
boolean
Marks the notification as deleted (soft delete)
string
Subject for email notification. Not necessary for in-App notification
string
From name for email/sms notification
boolean
Is the notification active
array
Specifies the time after which the follow-up notification should be sent. This is not required for other notification types.
array
Specifies the time before which the reminder notification should be sent. This is not required for other notification types.
string
required
Calendar that owns the notification setting.
string
from number for sms notification
string
Template ID for email notification
string
From address for email notification
string ("contact" | "guest" | "assignedUser" | "emails" | "phoneNumbers" | "business")
Notification recipient type
array
Selected users for in-App and business email notifications. Supports user IDs and special keyword “sub_account_admin”
string
required
Notification setting to update.
string ("booked" | "confirmation" | "cancellation" | "reminder" | "followup" | "reschedule")
Notification type
array
Additional email addresses to receive notifications.
array
Additional phone numbers to receive notifications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_UPDATE_SCHEDULEModify an existing schedule by updating its rules, timezone, and name All fields are optional - only provided fields will be updated. Location PITs must be provisioned with the HighLevel permission: calendars.write.

Input Parameters

string
required
Unique identifier of the schedule to update
string
Human-readable name for the schedule
array
Updated schedule rules defining when the schedule is active
string
Updated timezone for the schedule (IANA timezone identifier)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Title
string ("confirmed" | "cancelled" | "invalid" | "new" | "showed" | "noshow")
Status
string
End time as ISO 8601 with a timezone offset.
array
If provided, services sent in the request will replace the existing services in the booking.
string
Timezone
string
required
Unique Service Booking ID
string
Start time as ISO 8601 with a timezone offset.
string
Meeting Location (If service location is an ask the booker, then the meeting location is required)
string
Service Location ID
boolean
If true the time slot validation would be avoided for any booking creation/update (even the skipSchedulingNotice)
boolean
If set to true, the minimum scheduling notice and date range would be ignored

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_UPDATE_SERVICE_CATALOGUpdate service by ID. Location PITs must be provisioned with the HighLevel permission: calendars.write.

Input Parameters

string
Service name
string
Unique URL-friendly identifier
array
Assigned staff members
string
Custom form ID (will be used to display the custom form on the booking page, if only one service is selected)
object
Payment details (currency configured in Service Global Settings is used.)
boolean
Whether service is private (not shown publicly)
number
Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
string
required
Service ID
array
Service variations (an empty array removes all variations). Include an id to update an existing variation; omit the id to create a new one.
string
Service cover image URL
string
Service description
string
Service event color (hex)
number
Post-buffer: Additional time that can be added after an appointment, allowing for extra time to wrap up
string ("mins" | "hours")
Pre-buffer unit
string ("mins" | "hours")
Post-buffer unit
number
This controls the duration of the appointment
string
Service category ID
string ("mins" | "hours")
Duration unit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_UPDATE_SERVICE_LOCATIONUpdate an existing service location Location PITs must be provisioned with the HighLevel permission: calendars.write.

Input Parameters

string
Location name
string
Updated URL-friendly slug identifier
string
Updated contact phone number
string
Use a full street address when locationType is offline. Use a user-facing label when locationType is ask_booker.
string
Updated URL of the cover image
string ("offline" | "ask_booker")
Location type
string
required
Unique Service Location ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CALENDARS_VALIDATE_GROUPS_SLUGValidate if group slug is available or not. Location PITs must be provisioned with the HighLevel permission: calendars/groups.write.

Input Parameters

string
required
Slug
string
Location ID supplied by the connected account; caller values are overwritten.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CAMPAIGNS_GET_CAMPAIGNSReturn campaigns for the connected HighLevel location, optionally filtered by status. Location PITs must be provisioned with the HighLevel permission: campaigns.readonly.

Input Parameters

string ("draft" | "published")
Filter campaigns by provider status, such as draft or published.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CHAT_WIDGET_CLONE_CHAT_WIDGETCreates a copy of a chat widget in the connected sub-account. Location PITs must be provisioned with the HighLevel permission: chat-widget.write.

Input Parameters

string
Name for the cloned chat widget.
string
required
ID of the chat widget to clone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Chat widget name.
boolean
Whether this is the default chat widget.
boolean
Whether the chat widget starts soft-deleted.
number
required
Chat widget schema version.
object
Documented widget appearance and messaging settings. The public API refuses 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.
string ("liveChat" | "emailChat")
required
Chat type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CHAT_WIDGET_DELETESoft-deletes a chat widget from the connected sub-account. Location PITs must be provisioned with the HighLevel permission: chat-widget.write.

Input Parameters

string
required
Chat widget ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CHAT_WIDGET_GET_CHAT_WIDGETReturns a single chat widget by ID from the connected sub-account. Location PITs must be provisioned with the HighLevel permission: chat-widget.readonly.

Input Parameters

string
required
Chat widget ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CHAT_WIDGET_GET_PUBLIC_CONFIGReturn a chat widget’s public configuration by widget ID. No endpoint-specific provider permission was evidenced beyond a valid Location token.

Input Parameters

string
required
Chat widget identifier.
string
Public widget configuration version. HighLevel defaults this to 2.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Maximum number of chat widgets to return.
integer
required
Offset from which to return chat widgets.
string ("liveChat" | "waChat" | "emailChat" | "allInOneChat" | "voiceAiChat" | "facebookChat" | "instagramChat" | "webChat")
Chat widget type, including the virtual “webChat” umbrella.
string ("liveChat" | "waChat" | "emailChat" | "allInOneChat" | "voiceAiChat" | "facebookChat" | "instagramChat")
Chat widget type to exclude.
string
Voice AI agent ID by which to filter widgets.
string ("liveChat" | "waChat" | "emailChat" | "allInOneChat" | "voiceAiChat" | "facebookChat" | "instagramChat" | "webChat")
All-in-one chat subtype. Applies when chat_type is “allInOneChat”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Chat widget ID.
string
Chat widget name.
boolean
Whether this is the default chat widget.
number
Chat widget schema version.
object
Documented widget settings to update. The public API refuses 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.
string ("liveChat" | "emailChat")
Chat type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Chat widget ID.
string
Chat widget name.
boolean
Whether this is the default chat widget.
number
Chat widget schema version.
object
Complete documented widget settings object. Because this PUT replaces the widget, preserve any existing settings that should remain. The public API refuses 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.
string ("liveChat" | "emailChat")
Chat type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_ADD_CONTACT_TO_CAMPAIGNAdd contact to Campaign Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

object
Request payload documented by HighLevel for this operation.
string
required
Contact Id
string
required
Campaign Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_ADD_CONTACT_TO_WORKFLOWAdd Contact to Workflow Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

string
required
Contact Id
string
required
Workflow Id
string
Start time of the workflow event (ISO 8601 format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_ADD_FOLLOWERS_CONTACTAdd Followers Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

array
required
List of user Ids to follow or unfollow the contact
string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_ADD_TAGSAdd Tags Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

array
required
List of tags to add or remove
string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Business ID to assign. Omit when remove_business is true.
array
required
Contact IDs whose business association will be changed.
boolean
Set true to remove the current business association. This flag is not sent to HighLevel.
boolean
required
Must be true to confirm changing or removing the business association for every listed contact. This value is not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_BULK_UPDATE_TAGSAdd or remove tags for multiple contacts, including optionally removing all tags. The action fails when HighLevel reports any contact-level error, even if the HTTP response says success. Confirm the operation type, contacts, and tags before calling. No Contacts-specific PIT permission was enforced by the completed minimal-PIT probe.

Input Parameters

array
required
Tags to add or remove.
string ("add" | "remove")
required
Whether to add or remove the supplied tags.
array
required
Contact IDs whose tags will be updated.
boolean
Remove every tag from the contacts. Supported only when type is remove.
boolean
required
Must be true to confirm the bulk tag mutation. This value is not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_CREATE_CONTACTCreate a new contact Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

boolean
Whether Do Not Disturb is enabled for the contact
string
City of the contact
string
Full name of the contact
array
List of tags to assign to the contact
string
Email address of the contact
string
Phone number of the contact
string
State of the contact
string
Gender of the contact
string
Source from which the contact was created
string
Country code of the contact (ISO 3166-1 alpha-2)
string
Website URL of the contact
string
Street address of the contact
string
Timezone of the contact
string
Last name of the contact
string
First name of the contact
string
User’s Id
string
Postal code of the contact
string
Company name of the contact
object
Per-channel DND settings. Use lowercase channel keys such as call and email; HighLevel rejects capitalized input keys even though read responses may capitalize them.
array
List of custom field values to assign to the contact
string
The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY
object
Inbound DND settings per channel for the contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_CREATE_NOTECreate Note Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

string
required
Body content of the note
string
Hex color code for the note
string
Title of the note
boolean
Whether the note is pinned
string
User Id of the note author
string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_CREATE_TASKCreate Task Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

string
Body or description of the task
string
required
Title of the task
string
required
Due date of the task (ISO 8601 format)
boolean
required
Whether the task is completed
string
required
Contact Id
string
User Id to whom the task is assigned

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_DELETE_CONTACTDelete Contact Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_DELETE_CONTACT_FROM_WORKFLOWDelete Contact from Workflow Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

string
required
Contact Id
string
required
Workflow Id
string
Start time of the workflow event (ISO 8601 format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_DELETE_NOTEDelete Note Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

string
required
Note Id
string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_DELETE_TASKDelete Task Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

string
required
Task Id
string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_GET_ALL_NOTESGet All Notes Location PITs must be provisioned with the HighLevel permission: contacts.readonly.

Input Parameters

string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_GET_ALL_TASKSGet all Tasks Location PITs must be provisioned with the HighLevel permission: contacts.readonly.

Input Parameters

string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_GET_APPOINTMENTS_FOR_CONTACTGet Appointments for Contact Location PITs must be provisioned with the HighLevel permission: contacts.readonly.

Input Parameters

string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_GET_CONTACTRetrieves a contact by its unique identifier. Location PITs must be provisioned with the HighLevel permission: contacts.readonly.

Input Parameters

string
required
Unique identifier of the contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_GET_CONTACTS_BY_BUSINESS_IDGet Contacts By BusinessId Location PITs must be provisioned with the HighLevel permission: contacts.readonly.

Input Parameters

integer
Number of records to skip on the first page
integer
Maximum number of records per page (up to 100, default 25)
string
Search query (name, email, phone)
string
Opaque continuation cursor returned by the previous page.
string
Business ID. Required on the first page; restored from the cursor later.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Raw email address; do not URL-encode it.
string
Raw E.164 phone number; do not URL-encode it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_GET_NOTEGet Note Location PITs must be provisioned with the HighLevel permission: contacts.readonly.

Input Parameters

string
required
Note Id
string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_GET_TASKGet Task Location PITs must be provisioned with the HighLevel permission: contacts.readonly.

Input Parameters

string
required
Task Id
string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_REMOVE_CONTACT_FROM_CAMPAIGNRemove Contact From Campaign Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

string
required
Contact Id
string
required
Campaign Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_REMOVE_CONTACT_FROM_EVERY_CAMPAIGNRemoves the contact from every campaign it is enrolled in. Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_REMOVE_FOLLOWERS_CONTACTRemove Followers Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

array
required
List of user Ids to follow or unfollow the contact
string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_REMOVE_TAGSRemove Tags Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

array
required
List of tags to add or remove
string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Request payload documented by HighLevel for this operation. Required on the first page and restored from the cursor later.
string
Opaque continuation cursor returned by the previous page.
integer
Maximum contacts to return on this page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_UPDATE_CONTACTUpdate a contact using contactId Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

boolean
Whether Do Not Disturb is enabled for the contact
string
City of the contact
string
Full name of the contact
array
This field will overwrite all current tags associated with the contact. To update a tags, it is recommended to use the Add Tag or Remove Tag API instead.
string
Email address of the contact
string
Phone number of the contact
string
State of the contact
string
Source from which the contact was updated
string
Country code of the contact (ISO 3166-1 alpha-2), Refer country list from documentaion, documentation has list of all countries
string
Website URL of the contact
string
Street address of the contact
string
Timezone of the contact
string
Last name of the contact
string
required
Unique identifier of the contact
string
First name of the contact
string
User’s Id
string
Postal code of the contact
object
Per-channel DND settings for the contact
array
List of custom field values to assign to the contact
string
The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY
object
Inbound DND settings per channel for the contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_UPDATE_NOTEUpdate Note Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

string
required
Note Id
string
Body content of the note
string
Hex color code for the note
string
Title of the note
boolean
Whether the note is pinned
string
User Id of the note author
string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_UPDATE_TASKUpdate Task Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

string
Body or description of the task
string
Title of the task
string
required
Task Id
string
Due date of the task (ISO 8601 format)
boolean
Whether the task is completed
string
required
Contact Id
string
User Id to whom the task is assigned

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONTACTS_UPDATE_TASK_COMPLETEDUpdate Task Completed Location PITs must be provisioned with the HighLevel permission: contacts.write.

Input Parameters

string
required
Task Id
boolean
required
Whether the task is completed
string
required
Contact Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether Do Not Disturb is enabled for the contact
string
City of the contact
string
Full name of the contact
array
This field will overwrite all current tags associated with the contact. To update a tags, it is recommended to use the Add Tag or Remove Tag API instead.
string
Email address of the contact
string
Phone number of the contact
string
State of the contact
string
Gender of the contact
string
Source from which the contact was created
string
Country code of the contact (ISO 3166-1 alpha-2)
string
Website URL of the contact
string
Street address of the contact
string
Timezone of the contact
string
Last name of the contact
string
First name of the contact
string
User’s Id
string
Postal code of the contact
string
Company name of the contact
object
Per-channel DND settings for the contact
array
List of custom field values to assign to the contact
string
The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY
object
Inbound DND settings per channel for the contact
boolean
Controls whether to create a new contact or update an existing duplicate. Scenario 1: If this value is 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Action name, from 3 to 50 characters.
string ("triggerWorkflow" | "updateContactField" | "appointmentBooking" | "stopBot" | "humanHandOver" | "advancedFollowup" | "transferBot")
required
Provider field type.
boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Strict action-specific configuration selected by type.
string
required
Provider field agentId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The goal of the agent.
string ("off" | "suggestive" | "auto-pilot")
Mode of operation - OFF, SUGGESTIVE, or AUTO_PILOT
string
required
Name of the agent.
boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
array
Communication channels the agent can operate on
number
Wait time before agent responds (max 5 for minutes, 300 for seconds)
boolean
Indicates if this agent is a primary agent.
number
Duration of sleep period (required if sleepEnabled is true). Set to null for indefinite sleep. (max 2880 for minutes, 172800 for seconds, 48 for hours)
string
required
Personality traits of the agent.
string
required
Instructions for the agent.
string
Name of the business the agent represents.
boolean
Indicates if sleep functionality is enabled.
string ("minutes" | "seconds")
Unit for wait time - SECONDS or MINUTES
string ("hours" | "minutes" | "seconds")
Unit of sleep time - HOURS, MINUTES, or SECONDS (required if sleepEnabled is true). Set to null for indefinite sleep.
boolean
Allow agent to respond to audio
boolean
Allow agent to respond to images
array
Array of knowledge base IDs associated with this agent.
number
Maximum number of messages in auto-pilot mode before requiring human intervention. (max: 100, min: 1)
boolean
Enable sleep when a manual outbound message is sent.
boolean
Enable sleep when a workflow outbound message is sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Provider field agentId.
string
required
The unique identifier of the action ID Attached to the agent

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Conversations AI agent id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Provider field agentId.
string
required
The unique identifier of the action ID Attached to the agent

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATION_AI_GET_AGENTRetrieves a specific AI agent by its ID. Returns the complete agent configuration including name, status, actions, and settings. Location PITs must be provisioned with the HighLevel permission: conversation-ai.readonly.

Input Parameters

string
required
Conversations AI agent id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("conversation" | "workflow")
required
Provider field source.
string
required
Message Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATION_AI_LIST_ACTIONSList for actions for an agent Location PITs must be provisioned with the HighLevel permission: conversation-ai.readonly.

Input Parameters

string
required
Provider field agentId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Records per page
string
query to search on agent name, must be provided in lowercase
string
Agent ID after which to continue. Omit this field on the first page; an empty string is treated as omitted, while whitespace-only values are rejected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Action name, from 3 to 50 characters.
string ("triggerWorkflow" | "updateContactField" | "appointmentBooking" | "stopBot" | "humanHandOver" | "advancedFollowup" | "transferBot")
required
Provider field 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.
boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Complete strict action-specific configuration selected by type.
string
required
Provider field agentId.
string
required
The unique identifier of the action ID Attached to the agent

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The goal of the agent.
string ("off" | "suggestive" | "auto-pilot")
Mode of operation for the agent, required if primary is enabled.
string
Name of the agent.
boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Conversations AI agent id
array
Channels the agent can use.
number
Wait time before agent responds (max 5 for minutes, 300 for seconds).
boolean
Indicates if this agent is a primary agent.
number
Duration of sleep period (required if sleepEnabled is true). Set to null for indefinite sleep. (max 2880 for minutes, 172800 for seconds, 48 for hours)
string
required
Personality traits of the agent.
string
required
Instructions for the agent.
string
Name of the business the agent represents.
boolean
Indicates if sleep functionality is enabled.
string ("minutes" | "seconds")
Unit for wait time - SECONDS or MINUTES
string ("hours" | "minutes" | "seconds")
Unit of sleep time - HOURS, MINUTES, or SECONDS (required if sleepEnabled is true). Set to null for indefinite sleep.
boolean
Allow agent to respond to audio
boolean
Allow agent to respond to images
array
Array of knowledge base IDs associated with this agent.
number
Maximum number of messages in auto-pilot mode before requiring human intervention. (max: 100, min: 1)
boolean
Enable sleep when a manual outbound message is sent.
boolean
Enable sleep when a workflow outbound message is sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Provider field agentId.
array
required
IDs of advancedFollowup actions. Other action types are rejected by HighLevel.
object
required
Follow-up settings to update. HighLevel may retain omitted settings, so send every desired setting when deterministic replacement is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Phone call dialer and receiver information
string
ISO-8601 date-time of the inbound message.
string
HTML Body of Email
string
required
Message Type
string
external mail provider’s message id
string
Message Body
string
Subject of the Email
array
List of email address to CC
string
Recipient email address. Required when type is Email.
string
Message direction. This inbound endpoint always uses inbound.
array
List of email address to BCC
string
Contact ID. Either contact_id or conversation_id is required.
string
Email address to send from. This field is associated with the contact record and cannot be dynamically changed.
array
Array of attachments
string
Conversation ID. Either conversation_id or contact_id is required.
string
Send the email message id for which this email should be threaded. This is for replying to a specific email
string
Conversation provider ID. Required only when using a custom or additional conversation provider; omit it for the default SMS or email provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_ADD_AN_OUTBOUND_MESSAGEPost the necessary fields for the API to add a new outbound call. Location PITs must be provisioned with the HighLevel permission: conversations/message.write.

Input Parameters

object
required
Call details including to, from, and status.
string
Date of the outbound message
string
required
Message Type
string
external mail provider’s message id
string
Contact ID used to resolve or create a conversation when conversation_id is omitted.
array
Array of attachments
string
Conversation ID. Either conversation_id or contact_id is required.
string
required
Conversation Provider Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Message Id
array
required
Array of attachment URLs to set on the message (replaces existing). Maximum 5 URLs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_CANCEL_SCHEDULED_EMAIL_MESSAGEPost the messageId for the API to delete a scheduled email message. Location PITs must be provisioned with the HighLevel permission: conversations/message.write.

Input Parameters

string
required
Email Message Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_CANCEL_SCHEDULED_MESSAGEPost the messageId for the API to delete a scheduled message. Location PITs must be provisioned with the HighLevel permission: conversations/message.write.

Input Parameters

string
required
Message Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_CREATE_CONVERSATIONCreates a new conversation with the data provided Location PITs must be provisioned with the HighLevel permission: conversations.write.

Input Parameters

string
required
Contact ID as string
string
Connected HighLevel Location ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_DELETE_CONVERSATIONDelete the conversation details based on the conversation ID Location PITs must be provisioned with the HighLevel permission: conversations.write.

Input Parameters

string
required
Conversation ID as string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_DOWNLOAD_MESSAGE_TRANSCRIPTIONDownload the recording transcription for a message by passing the message id Location PITs must be provisioned with the HighLevel permission: conversations/message.readonly.

Input Parameters

string
required
Message ID as string
string
Connected HighLevel Location ID; always taken from the connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of messages to return per page (minimum 10, maximum 1000).
string
Cursor returned by the previous export page.
string
Filter by message channel. Optional - when not provided, all non-email message types will be returned including activity messages (opportunity updates, appointments, etc.). To fetch email messages, you must explicitly set channel=Email.
string
Field to sort by
string
End date to filter messages by
string
Filter messages by contact ID
string
Sort order
string
Start date to filter messages by
string
Filter messages by conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_GET_CONVERSATIONGet the conversation details based on the conversation ID Location PITs must be provisioned with the HighLevel permission: conversations.readonly.

Input Parameters

string
required
Conversation ID as string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_GET_EMAIL_BY_IDGet email by Id Location PITs must be provisioned with the HighLevel permission: conversations/message.readonly.

Input Parameters

string
required
id from the documented endpoint path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_GET_MESSAGEGet message by message id. Location PITs must be provisioned with the HighLevel permission: conversations/message.readonly.

Input Parameters

string
required
HighLevel message ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_GET_MESSAGE_RECORDINGGet the recording for a message by passing the message id Location PITs must be provisioned with the HighLevel permission: conversations/message.readonly.

Input Parameters

string
required
Message ID as string
string
Connected HighLevel Location ID; always taken from the connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_GET_MESSAGESGet messages by conversation id. Location PITs must be provisioned with the HighLevel permission: conversations/message.readonly.

Input Parameters

string
Comma-separated message types. Use TYPE_INTERNAL_COMMENTS for internal comments.
integer
Number of messages to be fetched from the conversation. Default limit is 20
string
required
Conversation ID as string
string
Message ID of the last message in the list as a string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_GET_MESSAGE_TRANSCRIPTIONGet the recording transcription for a message by passing the message id Location PITs must be provisioned with the HighLevel permission: conversations/message.readonly.

Input Parameters

string
required
Message ID as string
string
Connected HighLevel Location ID; always taken from the connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Whether the agent or AI bot is currently typing.
string
required
Unique ID assigned to each live chat visitor.
string
Connected HighLevel Location ID.
string
required
Conversation Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Id of the conversation
string
Sort paramater - asc or desc
integer
Number of conversations to return (1-100); defaults to 20.
string
Search paramater as a string
string
Opaque cursor returned by the previous page.
string
The status of the conversation to be filtered - all, read, unread, starred
string
The sorting of the conversation to be filtered as - manual messages or all messages
string
End date filter for dateAdded field (Unix timestamp in milliseconds)
string
User Id of the mention. Multiple values are comma separated.
string
User IDs of followers to filter conversations by. Multiple IDs can be provided as comma-separated values.
string
Contact Id
string
Start date filter for dateAdded field (Unix timestamp in milliseconds)
string
User IDs that conversations are assigned to. Multiple IDs can be provided as comma-separated values. Use “unassigned” to fetch conversations not assigned to any user.
string
Id of score profile on which conversations should get filtered out, works with scoreProfileMin & scoreProfileMax
string
Type of the last message in the conversation as a string
string
Maximum value for score
string
Minimum value for score
string
Id of score profile on which sortBy.ScoreProfile should sort on
string
Action of the last outbound message in the conversation as string.
string
Direction of the last message in the conversation as string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
HTML content of the message
string ("SMS" | "RCS" | "Email" | "WhatsApp" | "IG" | "FB" | "Custom" | "Live_Chat" | "TIKTOK" | "InternalComment")
required
Type of message being sent
string
Message status for messages recorded by a custom conversation provider.
object
Forwarding configuration for emails
string
Text content of the message
string
Subject line for email messages
string
User to attribute an InternalComment message to.
array
Array of CC email addresses
string
Email address to send to, if different from contact’s primary email. This should be a valid email address associated with the contact.
array
User IDs mentioned by an InternalComment message using @username userId text.
string ("SMS" | "RCS" | "Email" | "WhatsApp" | "IG" | "FB" | "Custom" | "Live_Chat" | "TIKTOK")
Optional provider message subtype.
object
WhatsApp-specific image, video, audio, or document payload.
array
Array of BCC email addresses
string
ID of message thread. For email messages, this is the message ID that contains multiple email messages in the thread
string
Recipient phone number for outbound messages
string
required
ID of the contact receiving the message
string
Email address to send from
array
Array of attachment URLs
string
Phone number used as the sender number for outbound messages
string
ID of message template
string
ID of the associated appointment
string
Mode for email replies
string
Email message ID being replied to, not the conversation message ID.
string
Custom subtype ID for email unsubscription preferences. Only applies to email messages.
string
Optimization period in hours (24h, 48h, or 72h)
string
UTC Timestamp (in seconds) at which the message should be scheduled
string
ID of conversation provider
boolean
Whether the scheduled email uses native AI for the email scheduling

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_UPDATE_CONVERSATIONUpdates a conversation by ID, changing its unread count, starred status, or live chat feedback. Location PITs must be provisioned with the HighLevel permission conversations.write.

Input Parameters

boolean
Starred status of the conversation.
string ("positive" | "negative")
Live chat feedback: positive or negative.
string
Connected HighLevel Location ID.
string
Count of unread messages in the conversation
string
required
Conversation ID as string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Email message id
object
Aggregate delivery event counters. Counters are merged into existing values. The API automatically infers related events (e.g., reporting clicked will also set opened and delivered if not already present). See the endpoint description for the full inference rules.
string
required
The overall status of the email message. Required on every request. For emails with multiple recipients, consider using the recipients array for granular tracking and this field for the aggregate status.
array
Per-recipient delivery statuses. Each entry maps a recipient email address to a delivery status. Entries are upserted — if a recipient already has a status, it will be overwritten with the new value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CONVERSATIONS_UPDATE_MESSAGE_STATUSPost the necessary fields for the API to update message status. Location PITs must be provisioned with the HighLevel permission: conversations/message.write.

Input Parameters

object
Error object from the conversation provider
string
required
Message status
string
required
Message Id
array
Email delivery status for additional email recipients.
string
Email message Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Contact Id
string
Connected HighLevel Location ID; always taken from the connection.
boolean
Flag to indicate group SMS upload flow. When true, only 1 file upload is allowed per request.
array
required
Non-empty array of attachment URLs to upload for the conversation
string
required
Conversation Id
string
Twilio chat service SID for group SMS uploads

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_COURSES_IMPORT_COURSESImport course products into the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: courses.write.

Input Parameters

string
HighLevel user ID associated with the import.
array
required
Non-empty list of course products to import.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Required Google manager account (MCC) ID, sent as mccId. Not accepted for Facebook or LinkedIn.
string
Required Facebook Page ID, sent as pageId. Not accepted for Google or LinkedIn.
string ("facebook" | "google" | "linkedin")
required
Ad platform whose equivalent operation to call.
string
Ad account ID sent as adAccountId. Required for Google and LinkedIn; optional for Facebook.
string
Required LinkedIn account currency code, sent as currencyCode. Not accepted for Facebook or Google.
string
Required LinkedIn ad account name, sent as adAccountName. Not accepted for Facebook or Google.
string
Required LinkedIn organization ID, sent as organizationId. Not accepted for Facebook or Google.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Field name.
array
Choices for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, or TEXTBOX_LIST fields.
string ("TEXT" | "LARGE_TEXT" | "NUMERICAL" | "PHONE" | "MONETORY" | "CHECKBOX" | "SINGLE_OPTIONS" | "MULTIPLE_OPTIONS" | "DATE" | "TEXTBOX_LIST" | "FILE_UPLOAD" | "RADIO" | "EMAIL")
required
Provider data type of the field to create.
string
required
Unique field key, such as custom_objects.pet.name. A bare field name is also accepted and HighLevel prefixes it for the selected object.
string
required
ID of the parent custom field folder.
string
required
Object key that will own the field. Use business for Company fields and custom_objects.<key> for custom objects.
string
Description of the field.
string
Placeholder text for the field.
boolean
required
Whether the field should be shown in forms.
number
Maximum number of files for a FILE_UPLOAD field.
array
Allowed upload extensions for a FILE_UPLOAD field, for example [“.pdf”, “.png”].
boolean
Whether RADIO records may use values outside the configured options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the custom field folder.
string
required
Object key that will own the folder. Use business for Company fields and custom_objects.<key> for custom objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the custom field to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_CUSTOM_FIELDS_DELETE_CUSTOM_FIELD_FOLDERPermanently delete a custom field folder from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: locations/customFields.write.

Input Parameters

string
required
ID of the custom field folder to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the custom field or folder to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object key whose custom fields and folders to return. Use business for Company fields and custom_objects.<key> for custom objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the custom field to update.
string
New field name.
array
Complete replacement option list. Include every existing option plus any new options; this operation does not support removing options.
string
New field description.
string
New placeholder text.
boolean
Whether the field should be shown in forms.
number
Maximum number of files for a FILE_UPLOAD field.
array
Allowed upload extensions for a FILE_UPLOAD field, for example [“.pdf”, “.png”].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the custom field folder to rename.
string
required
New name for the custom field folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("facebook" | "google" | "linkedin")
required
Ad platform whose equivalent operation to call.
string
required
Required ad account ID for every platform. Sent as a Facebook/Google adAccountId path parameter or a LinkedIn adAccountId query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("email" | "contact")
required
Whether verify is an email address or a HighLevel contact ID.
string
required
Email address or HighLevel contact ID to verify. This request may charge the connected location or company wallet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_CREATE_EMAIL_CAMPAIGNCreate an email campaign draft without scheduling or sending it. Location PITs must be provisioned with the HighLevel permission: emails/campaigns.write.

Input Parameters

string
required
Campaign name.
string
required
ID of the user creating the draft.
string
required
IANA timezone for the campaign.
string
Name of the user creating the draft.
string ("html" | "text")
required
Editor type for campaign content.
string
Existing template ID to create the draft from.
string
required
Initial HTML or plain-text campaign content.
string
Parent folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_CREATE_EMAIL_TEMPLATECreate a new email template in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: emails/templates.write.

Input Parameters

string
required
Template name.
string
ID of the user performing the action.
string
Sender name.
string
Sender email address.
string ("html" | "text")
required
Editor type for the template.
string
Inbox preview text.
string
Email subject line.
string
required
Initial HTML or plain-text content.
string
Parent folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_CREATE_TEMPLATE_FOLDERCreate an email-template folder in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: emails/templates.write.

Input Parameters

string
required
Folder name.
string
ID of the user performing the action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Campaign ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_DELETE_EMAIL_TEMPLATEPermanently delete one email template from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: emails/templates.write.

Input Parameters

string
required
Template ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_GET_BULK_ACTION_CAMPAIGNGet one bulk-action campaign from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: emails/campaigns.readonly.

Input Parameters

string
required
Bulk-action campaign ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("email-campaigns" | "workflow-campaigns" | "bulk-actions")
required
Campaign source type.
string
required
Schedule source ID returned by the selected email-campaign, workflow-campaign, or bulk-action schedule. This is not the campaign ID.
string
Workflow action ID; valid only for workflow-campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_GET_EMAIL_CAMPAIGNGet one email campaign from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: emails/campaigns.readonly.

Input Parameters

string
required
Campaign ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_GET_EMAIL_TEMPLATEGet one email template from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: emails/templates.readonly.

Input Parameters

string
required
Template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_GET_WORKFLOW_CAMPAIGNGet one workflow campaign from the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: emails/campaigns.readonly.

Input Parameters

string
required
Workflow campaign ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_IMPORT_EMAIL_TEMPLATEImport an email template from a supported provider URL into the connected location. Location PITs must be provisioned with the HighLevel permission: emails/templates.write.

Input Parameters

string
Name for the imported template.
string
ID of the user performing the action.
string
required
Public template import URL.
string ("mailchimp" | "active_campaign")
required
Provider from which to import the template.
string
Parent folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_LIST_BULK_ACTION_CAMPAIGNSReturn one page of bulk-action campaigns for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: emails/campaigns.readonly.

Input Parameters

integer
Number of campaigns to return (1-20).
string
Opaque continuation cursor returned by the previous call.
integer
Number of campaigns to skip.
string
Search text for bulk-action campaigns.
string ("processing" | "scheduled" | "paused" | "complete" | "cancelled")
Campaign status filter.
string
Inclusive ISO 8601 end date.
string
Inclusive ISO 8601 start date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of campaigns to return (1-20).
string
Opaque continuation cursor returned by the previous call.
integer
Number of campaigns to skip.
string
Search text for campaign name.
string ("all" | "sent" | "failed" | "archived" | "draft" | "processing" | "scheduled" | "cancelled" | "paused")
Campaign status filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_LIST_EMAIL_TEMPLATESReturn one page of email templates and folders for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: emails/templates.readonly.

Input Parameters

integer
Number of items to return (1-20).
string
Opaque continuation cursor returned by the previous call.
integer
Number of items to skip.
string
Search by template name.
string ("all" | "templates" | "folders")
Kinds of items to include.
string
Field to sort by; HighLevel supports only updatedAt.
boolean
Whether to return archived templates.
string
Folder ID, or root for top-level items.
string ("asc" | "desc")
Sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_LIST_WORKFLOW_CAMPAIGNSReturn one page of workflow campaigns for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: emails/campaigns.readonly.

Input Parameters

integer
Number of campaigns to return (1-20).
string
Opaque continuation cursor returned by the previous call.
integer
Number of campaigns to skip.
string
Search text for workflow campaigns.
string ("draft" | "published")
Workflow campaign status filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the user scheduling the campaign.
array
Allowed send days for batch and RSS schedules: Mon, Tue, Wed, Thu, Fri, Sat, or Sun.
string
required
IANA timezone.
string
Name of the user scheduling the campaign.
object
required
Subject, sender, and email metadata.
object
required
Validated recipient selection.
object
RSS schedule configuration.
string
required
Draft or paused campaign ID. A cancelled campaign cannot be rescheduled; create a new draft.
string ("immediate" | "scheduled" | "batch" | "rss" | "smart_send")
required
How to start or schedule the campaign.
object
Optional A/B test configuration; unavailable for RSS.
object
Non-RSS schedule configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_UPDATE_EMAIL_CAMPAIGNUpdate selected fields of an email campaign draft; this action never schedules or sends it. Location PITs must be provisioned with the HighLevel permission: emails/campaigns.write.

Input Parameters

string
Campaign name.
string
ID of the user performing the update.
string
required
Draft campaign ID.
string ("html" | "text")
Content editor type; provide with editor_content.
string
Updated HTML or plain-text content; provide with editor_type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_EMAILS_UPDATE_EMAIL_TEMPLATEUpdate selected fields of an email template in the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: emails/templates.write.

Input Parameters

string
Template name.
string
ID of the user performing the action.
boolean
Whether the template is archived.
string
Sender name.
string
Sender email address.
string ("html" | "text")
Content editor type; provide with editor_content.
string
required
Template ID.
string
Inbox preview text.
string
Email subject line.
string
Updated HTML or plain-text content; provide with editor_type.
string
Parent folder ID, or the sentinel root to move the template to the root folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
required
Share-link slug identifying the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_FORMS_GET_FORMSReturn one offset-based page of forms for the connected HighLevel location. Pass next_cursor back as skip to retrieve the next page. Location PITs must be provisioned with the HighLevel permission: forms.readonly.

Input Parameters

integer
Number of matching forms to skip.
integer
Maximum forms to return (1-50).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_FORMS_GET_FORMS_SUBMISSIONSReturn one page of form submissions for the connected HighLevel location. Pass next_cursor back as page to retrieve the next page. Location PITs must be provisioned with the HighLevel permission: forms.readonly.

Input Parameters

string
Match a contact ID, name, email address, or phone number.
integer
One-based submission page number.
integer
Maximum submissions to return (1-100).
string
Inclusive end date in YYYY-MM-DD format.
string
Return submissions for this form only.
string
Inclusive start date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_FORMS_UPLOAD_TO_CUSTOM_FIELDSUpload one or more files to file-upload custom fields on a contact in the connected HighLevel location. Each file may be up to 50 MB. Location PITs must be provisioned with the HighLevel permission: forms.write.

Input Parameters

array
required
Files to upload. Each multipart key is <custom_field_id>_<file_id>.
string
required
Identifier of the contact whose custom fields to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Path to redirect.
string ("funnel" | "website" | "url" | "all")
required
Type of redirect target.
string
required
Domain where the redirect starts. The domain must already be connected to this HighLevel location before the redirect can be created.
string
required
Destination URL or resource identifier.
string
Connected HighLevel Location ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_FUNNELS_DELETE_REDIRECT_BY_IDPermanently delete a URL redirect from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: funnels/redirect.write.

Input Parameters

string
required
Redirect ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_FUNNELS_FETCH_REDIRECTS_LISTReturn one offset-based page of URL redirects for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: funnels/redirect.readonly.

Input Parameters

integer
required
Maximum redirects to return.
integer
required
Number of redirects to skip.
string
Optional redirect search text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_FUNNELS_GET_FUNNELSReturn one offset-based page of funnels for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: funnels/funnel.readonly.

Input Parameters

string
Optional funnel name filter.
string
Optional funnel type filter.
integer
Maximum funnels to return.
string
Opaque continuation cursor returned by the previous call.
integer
Provider offset for this page.
string
Optional funnel category filter.
string
Optional parent funnel ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_FUNNELS_GET_PAGES_BY_FUNNEL_IDReturn one offset-based page of pages belonging to a HighLevel funnel. Location PITs must be provisioned with the HighLevel permission: funnels/page.readonly.

Input Parameters

string
Optional page name filter.
integer
required
Maximum pages to return.
integer
required
Number of pages to skip.
string
required
Funnel ID whose pages should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_FUNNELS_GET_PAGES_COUNT_BY_FUNNEL_IDCount pages belonging to a HighLevel funnel, optionally filtered by name. Location PITs must be provisioned with the HighLevel permission: funnels/pagecount.readonly.

Input Parameters

string
Optional page name filter.
string
required
Funnel ID whose pages should be counted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_FUNNELS_UPDATE_REDIRECT_BY_IDUpdate the destination and action of an existing HighLevel URL redirect. Location PITs must be provisioned with the HighLevel permission: funnels/redirect.write.

Input Parameters

string
required
Redirect ID to update.
string ("funnel" | "website" | "url" | "all")
required
Type of redirect target.
string
required
New destination URL or resource identifier.
string
Connected HighLevel Location ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Optional draft-selection flag for Facebook and Google, sent as isDraft. Not accepted for LinkedIn.
string ("facebook" | "google" | "linkedin")
required
Ad platform whose equivalent operation to call.
string
required
Required ad account ID for Facebook, Google, and LinkedIn. Sent as the Facebook/Google adAccountId path parameter or the LinkedIn adAccountId query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Required Facebook or Google report end date, sent as endDate.
string ("facebook" | "google")
required
Ad platform whose equivalent operation to call.
string
required
Required Facebook or Google report start date, sent as startDate.
string
required
Required 24-character HighLevel campaign ID for Facebook or Google. The campaign must already be published; do not pass the Meta or Google Ads campaign ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_GET_AD_PLATFORM_INTEGRATIONReturn the Location’s integration state for one ad platform. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

boolean
Optional draft-selection flag for Facebook, Google, and LinkedIn, sent as isDraft.
string ("facebook" | "google" | "linkedin")
required
Ad platform whose equivalent operation to call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_GET_AD_PLATFORM_USERReturn the current user from one connected ad platform. Location PITs must be provisioned with the HighLevel permission: adPublishing.readonly.

Input Parameters

boolean
Optional draft-selection flag for Facebook, Google, and LinkedIn, sent as isDraft.
string ("facebook" | "google" | "linkedin")
required
Ad platform whose equivalent operation to call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("AD_MANAGER" | "INTEGRATION")
Required Facebook or Google integration source: AD_MANAGER or INTEGRATION, sent as type. Not accepted for LinkedIn.
string ("ACCOUNT" | "CAMPAIGN" | "CAMPAIGN_GROUP" | "CREATIVE")
Optional LinkedIn analytics pivot: ACCOUNT, CAMPAIGN, CAMPAIGN_GROUP, or CREATIVE. Sent as pivot; not accepted for Facebook or Google.
array
Metrics to return. Required for Facebook and Google; optional for LinkedIn. Facebook accepts impressions, clicks, spend, cpc, cost_per_conversion, conversions, results, cost_per_result, cpm, reach, frequency, and ctr. Google accepts impressions, clicks, cost_micros, average_cpc, conversions, average_cpm, cost_per_conversion, and ctr. LinkedIn accepts clicks, oneClickLeads, costInLocalCurrency, impressions, costInUsd, ctr, cpc, cpm, cpl, externalWebsitePostClickConversions, and conversionRate.
string
required
Required report end date for Facebook, Google, and LinkedIn, sent as endDate.
string ("day" | "date" | "week" | "month" | "year")
Optional reporting interval sent as groupBy: Facebook accepts day, week, or month; Google accepts date, week, or month; LinkedIn accepts day, month, or year.
string ("facebook" | "google" | "linkedin")
required
Ad platform whose equivalent operation to call.
string
required
Required report start date for Facebook, Google, and LinkedIn, sent as startDate.
string
Optional comma-separated LinkedIn entity URNs, sent as entityUrns. Not accepted for Facebook or Google.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
string
required
Schedule Id
object
required
Complete automatic-payment configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
string
required
Schedule Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Meta data for the estimate
string
required
Estimate Name
array
required
An array of items for the estimate.
string
required
Title for the estimate
string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
string
required
Currency code
object
required
Discount configuration applied by the template.
boolean
livemode for estimate
array
attachments for the invoice
string
Terms notes, Also supports HTML markups
object
required
Business identity and address shown on estimates from the template.
object
Optional charge selection. Each charges entry must reference an existing charge _id and include enabled.
object
When sending estimate directly while saving
string
Prefix for the estimate number
boolean
Automatic taxes enabled for the Estimate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Invoice Name
array
required
An array of items for the invoice.
string
Title for the invoice
string
Tenant identifier supplied by the connected account; caller values are overwritten.
object
required
Invoice recipient email, CC, BCC, and phone details.
string
Fixed provider tenant discriminator.
string
required
Currency code
object
required
Invoice discount configuration, including type and value.
string
Due date in YYYY-MM-DD format
boolean
required
Whether payment collection uses live rather than test mode.
string
required
Issue date in YYYY-MM-DD format
array
attachments for the invoice
string
Terms notes, Also supports HTML markups
string
Invoice Number
object
required
Contact information to send the invoice to
object
Payment Methods for Invoices
object
required
Business identity and address shown on the invoice.
object
split invoice into payment schedule summing up to full invoice amount
object
tips configuration for the invoice
string
prefix for invoice number
object
Optional charge selection. Each charges entry must reference an existing charge _id and include enabled.
boolean
Automatic taxes enabled for the Invoice
object
late fees configuration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Tenant identifier supplied by the connected account; caller values are overwritten.
string ("v1" | "v2")
Version of the update request
string
Fixed provider tenant discriminator.
string
required
Estimate Id
boolean
required
Mark Estimate as Invoiced

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name used to identify the invoice schedule.
array
required
Complete line items used for each scheduled invoice.
string
Customer-visible scheduled-invoice title.
string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
string
required
ISO 4217 currency code for scheduled invoices.
object
required
Discount configuration applied to scheduled invoices.
object
required
Schedule containing exactly one recurring rrule or one-off executeAt timestamp.
boolean
required
Whether scheduled invoices use live rather than test payment mode.
array
attachments for the invoice
string
Terms and notes shown on scheduled invoices.
object
required
Recipient contact details for scheduled invoices.
object
Payment Methods for Invoices
object
required
Business identity and address shown on scheduled invoices.
object
Configuration for tips on invoices
string
prefix for invoice number
object
Optional charge selection. Each charges entry must reference an existing charge _id and include enabled.
boolean
Automatic taxes enabled for the Invoice
object
Late fees configuration for the invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the template
array
required
Line items included in invoices created from the template.
string
Template title
string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
string
required
ISO 4217 currency code for invoices from the template.
object
required
Discount configuration applied by the template.
boolean
Whether the template is internal; HighLevel currently stores true as false.
array
attachments for the invoice
string
Terms and notes shown on invoices created from the template.
object
Payment Methods for Invoices
object
required
Business identity and address shown on invoices from the template.
object
Configuration for tips on invoices
string
prefix for invoice number
object
Optional charge selection. Each charges entry must reference an existing charge _id and include enabled.
boolean
Automatic taxes enabled for the Invoice
object
Late fees configuration for the invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Meta data for the estimate
string
required
Estimate Name
array
required
An array of items for the estimate.
string
required
Title for the estimate
string
Tenant identifier supplied by the connected account; caller values are overwritten.
object
Email and sent to details for the estimate
string
User Id
string
Fixed provider tenant discriminator.
string
required
Currency code
object
required
Estimate discount configuration, including type and value.
boolean
livemode for estimate
string
required
Estimate issue date in YYYY-MM-DD format.
array
attachments for the invoice
string
required
Estimate expiry date in YYYY-MM-DD format.
string
Terms notes, Also supports HTML markups
object
Auto invoice for the estimate
object
required
Contact information to send the estimate to
number
Estimate Number, if not specified will take in the next valid estimate number
object
required
Business identity and address shown on the estimate.
object
required
frequency settings for the estimate
object
Optional charge selection. Each charges entry must reference an existing charge _id and include enabled.
object
When sending estimate directly while saving
string
Prefix for the estimate number
boolean
Automatic taxes enabled for the Estimate
object
Payment Schedule Config for the estimate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
string
required
Estimate Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
string
required
Template Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Invoice Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Schedule Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_DELETE_INVOICE_TEMPLATEPermanently delete an invoice template by ID. Confirm the target template before calling because this destructive change may be irreversible. Location PITs must be provisioned with invoices/template.write.

Input Parameters

string
required
Template Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_GENERATE_ESTIMATE_NUMBERGet the next estimate number for the given location. Location PITs must be provisioned with the HighLevel permission: invoices/estimate.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_GENERATE_INVOICE_NUMBERGet the next invoice number for the given location. Location PITs must be provisioned with the HighLevel permission: invoices.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_GET_INVOICEGet an invoice by ID. HighLevel returns not found for voided invoices even though LIST_INVOICES can still return them with status=void. Location PITs must be provisioned with the HighLevel permission: invoices.readonly.

Input Parameters

string
required
Invoice Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_GET_INVOICE_SCHEDULEAPI to get an schedule by schedule id. Location PITs must be provisioned with the HighLevel permission: invoices/schedule.readonly.

Input Parameters

string
required
Schedule Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_GET_INVOICE_SETTINGSGet the invoice settings for the given location. Location PITs must be provisioned with the HighLevel permission: invoices.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_GET_INVOICE_TEMPLATEAPI to get an template by template id. Location PITs must be provisioned with the HighLevel permission: invoices/template.readonly.

Input Parameters

string
required
Template Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_LIST_ESTIMATESGet a paginated list of estimates. Location PITs must be provisioned with the HighLevel permission: invoices/estimate.readonly.

Input Parameters

integer
Limit the number of items to return
string
Opaque continuation cursor returned by the previous call.
string
endAt in YYYY-MM-DD format
integer
Number of items to skip
string
search text for estimates name
string ("all" | "draft" | "sent" | "accepted" | "declined" | "invoiced" | "viewed")
estimate status
string
startAt in YYYY-MM-DD format
string
Contact ID for the estimate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_LIST_ESTIMATE_TEMPLATESGet a list of estimate templates or a specific template by ID. Location PITs must be provisioned with the HighLevel permission: invoices/estimate.readonly.

Input Parameters

integer
Limit the number of items to return
string
Opaque continuation cursor returned by the previous call.
integer
Number of items to skip
string
To search for an estimate template by id / name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_LIST_INVOICESAPI to get list of invoices. Location PITs must be provisioned with the HighLevel permission: invoices.readonly.

Input Parameters

integer
Limit the number of items to return
string
Opaque continuation cursor returned by the previous call.
string
Inclusive end date in YYYY-MM-DD format.
integer
Number of items to skip
string
To search for an invoice by id / name / email / phoneNo
string
status to be filtered
string
Inclusive start date in YYYY-MM-DD format.
string
Contact ID for the invoice
string
The field on which sorting should be applied
string ("ascend" | "descend")
The order of sort which should be applied for the sortField
string ("default" | "live" | "test")
payment mode

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_LIST_INVOICE_SCHEDULESAPI to get list of schedules. Location PITs must be provisioned with the HighLevel permission: invoices/schedule.readonly.

Input Parameters

integer
Limit the number of items to return
string
Opaque continuation cursor returned by the previous call.
string
Inclusive end date in YYYY-MM-DD format.
integer
Number of items to skip
string
To search for an invoice by id / name / email / phoneNo
string
status to be filtered
string
Inclusive start date in YYYY-MM-DD format.
string ("default" | "live" | "test")
payment mode

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_LIST_INVOICE_TEMPLATESAPI to get list of templates. Location PITs must be provisioned with the HighLevel permission: invoices/template.readonly.

Input Parameters

integer
Limit the number of items to return
string
Opaque continuation cursor returned by the previous call.
string
Inclusive end date in YYYY-MM-DD format.
integer
Number of items to skip
string
To search for an invoice by id / name / email / phoneNo
string
status to be filtered
string
Inclusive start date in YYYY-MM-DD format.
string ("default" | "live" | "test")
payment mode

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_PREVIEW_ESTIMATE_TEMPLATEGet a preview of an estimate template. Location PITs must be provisioned with the HighLevel permission: invoices/estimate.readonly.

Input Parameters

string
required
Template Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Optional receipt details: brand, type, and last4.
object
Optional metadata recorded with the manual payment.
string ("cash" | "card" | "cheque" | "bank_transfer" | "other")
required
manual payment method
string
required
Any note to be recorded with the transaction
string
Tenant identifier supplied by the connected account; caller values are overwritten.
number
Positive amount to record. Omit to record the full remaining balance; payment-plan invoices accept only scheduled step amounts.
object
Optional receipt details containing the cheque number.
string
Fixed provider tenant discriminator.
string
required
Invoice Id
string
Updated At to be recorded against the invoice.
array
Payment Schedule Ids to be recorded against the invoice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
boolean
required
Whether scheduled invoices use live rather than test payment mode.
string
required
Schedule Id
object
required
Complete automatic-payment configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("sms_and_email" | "send_manually" | "email" | "sms")
required
Delivery channel or manual-send operation for the estimate.
string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
required
Please ensure that the UserId corresponds to an authorized personnel, either by an employee ID or agency ID, to access this location. This account will serve as the primary channel for all future communications and updates.
string
Fixed provider tenant discriminator.
boolean
required
livemode for estimate
object
sender details for invoice, valid only if invoice is not sent manually
string
required
Estimate Id
string
estimate name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("sms_and_email" | "send_manually" | "email" | "sms")
required
Delivery channel: email, SMS, both, or mark as sent manually.
string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
required
Please ensure that the UserId corresponds to an authorized personnel, either by an employee ID or agency ID, to access this location. This account will serve as the primary channel for all future communications and updates.
string
Fixed provider tenant discriminator.
boolean
required
Whether payment collection uses live rather than test mode.
object
sender details for invoice, valid only if invoice is not sent manually
string
required
Invoice Id
object
auto-payment configuration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
id of invoice to update. If skipped, a new invoice will be created
string
required
Invoice Name
array
required
An array of items for the invoice.
string
Invoice title accepted in the request but currently ignored by HighLevel text-to-pay.
string ("draft" | "send")
required
create invoice in draft mode or send mode
string
Tenant identifier supplied by the connected account; caller values are overwritten.
object
required
Invoice recipient email, CC, BCC, and phone details; HighLevel ignores this field for text-to-pay.
string
required
id of user generating invoice
string
Fixed provider tenant discriminator.
string
required
Currency code
object
Invoice discount configuration, including type and value.
string
Due date in YYYY-MM-DD format
boolean
required
Whether payment collection uses live rather than test mode.
string
required
Issue date in YYYY-MM-DD format
array
attachments for the invoice
string
Terms notes accepted in the request but currently ignored by HighLevel text-to-pay.
string
Invoice Number
object
required
Contact information to send the invoice to
object
Payment Methods for Invoices
object
Business identity and address shown on the invoice.
object
split invoice into payment schedule summing up to full invoice amount
boolean
include terms & notes with receipts
object
tips configuration for the invoice
string
prefix for invoice number
object
Optional charge selection. Each charges entry must reference an existing charge _id and include enabled.
boolean
Automatic taxes enabled for the Invoice
object
late fees configuration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Replacement name used to identify the invoice schedule.
array
required
Complete replacement line items for scheduled invoices.
string
Replacement customer-visible scheduled-invoice title.
string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
string
required
ISO 4217 currency code for scheduled invoices.
object
required
Complete replacement discount configuration.
object
required
Complete schedule containing exactly one rrule or executeAt. The schedule must already be in scheduled state; include every setting that must be preserved.
boolean
required
Whether scheduled invoices use live rather than test payment mode.
array
Attachments for the invoice.
string
required
Schedule Id
string
Replacement terms and notes shown on scheduled invoices.
object
required
Required automatic-payment setting for the activated schedule. Enabling it may charge the contact’s configured payment method.
object
required
Complete recipient contact details to retain on the schedule.
object
Complete replacement payment-method settings.
object
required
Complete business identity and address to retain on invoices.
object
Complete replacement tips configuration.
object
Optional charge selection. Each charges entry must reference an existing charge _id and include enabled.
boolean
Whether automatic taxes are enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Meta data for the estimate
string
required
Estimate Name
array
required
An array of items for the estimate.
string
required
Title for the estimate
string
Tenant identifier supplied by the connected account; caller values are overwritten.
object
Email and sent to details for the estimate
string
User Id
string
Fixed provider tenant discriminator.
string
required
Currency code
object
required
Complete estimate discount configuration, including type and value.
boolean
livemode for estimate
string
required
Estimate issue date in YYYY-MM-DD format.
array
attachments for the invoice
string
required
Estimate Id
string
required
Estimate expiry date in YYYY-MM-DD format.
string
Terms notes, Also supports HTML markups
object
Auto invoice for the estimate
object
required
Contact information to send the estimate to
number
Estimate Number, if not specified will take in the next valid estimate number
string ("draft" | "sent" | "invoiced" | "viewed")
Estimate status to set. Accepted and declined are customer-only transitions and cannot be set through this action.
object
required
Business identity and address shown on the estimate.
object
required
frequency settings for the estimate
object
Optional charge selection. Each charges entry must reference an existing charge _id and include enabled.
object
When sending estimate directly while saving
string
Prefix for the estimate number
boolean
Automatic taxes enabled for the Estimate
object
Payment Schedule Config for the estimate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Estimate Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Meta data for the estimate
string
required
Estimate Name
array
required
An array of items for the estimate.
string
Title for the estimate
string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
string
required
Currency code
object
required
Complete replacement discount configuration.
boolean
livemode for estimate
array
attachments for the invoice
string
required
Template Id
string
Terms notes, Also supports HTML markups
object
required
Complete business identity and address retained by the template.
object
Optional charge selection. Each charges entry must reference an existing charge _id and include enabled.
object
When sending estimate directly while saving
string
Prefix for the estimate number
boolean
Automatic taxes enabled for the Estimate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name to be updated
string
Title for the invoice
string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
string
required
Currency
object
required
Full discount configuration retained by this replacement update.
string
required
Due date in YYYY-MM-DD format
boolean
Payment mode
string
Id of the contact which you need to send the invoice
string
required
Invoice Id
string
required
Issue date in YYYY-MM-DD format
array
attachments for the invoice
string
Description
string
Terms notes, Also supports HTML markups
object
Optional Xero accounting integration details retained by the invoice.
array
required
Complete replacement line items for the invoice.
string
Invoice Number
object
required
Full contact details retained by this replacement update.
object
Payment Methods for Invoices
object
required
Business details which need to be updated
object
split invoice into payment schedule summing up to full invoice amount
object
tips configuration for the invoice
string
prefix for invoice number
object
Optional charge selection. Each charges entry must reference an existing charge _id and include enabled.
boolean
Automatic taxes enabled for the Invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_INVOICES_UPDATE_INVOICE_LAST_VISITED_ATMark an invoice as last visited in the connected Location. Location PITs must be provisioned with the HighLevel permission: invoices.write.

Input Parameters

string
required
Invoice ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Invoice ID.
object
required
Complete late-fee configuration to apply.
boolean
required
Must be true to confirm this changes fees on a financial record. Not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Replacement name used to identify the invoice schedule.
array
required
Complete replacement line items for scheduled invoices.
string
Replacement customer-visible scheduled-invoice title.
string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
string
required
ISO 4217 currency code for scheduled invoices.
object
required
Complete replacement discount configuration.
object
required
Complete schedule containing exactly one rrule or executeAt. This update replaces the schedule object, so include every existing schedule setting that must be preserved.
boolean
required
Whether scheduled invoices use live rather than test payment mode.
array
attachments for the invoice
string
required
Schedule Id
string
Replacement terms and notes shown on scheduled invoices.
object
required
Complete recipient contact details to retain on the schedule.
object
Complete replacement payment-method settings.
object
required
Complete business identity and address to retain on invoices.
object
Complete replacement tips configuration.
object
Optional charge selection. Each charges entry must reference an existing charge _id and include enabled.
boolean
Whether automatic taxes are enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the template
array
required
Complete replacement line items for the template.
string
Template title
string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
string
required
ISO 4217 currency code retained by the template.
object
required
Complete replacement discount configuration.
boolean
Whether the template is internal.
string
required
Template Id
string
Terms and notes shown on invoices created from the template.
object
required
Complete business identity and address retained by the template.
object
Optional charge selection. Each charges entry must reference an existing charge _id and include enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Template ID.
object
required
Complete late-fee configuration to apply.
boolean
required
Must be true to confirm this changes future invoice-template fee behavior. Not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Template ID.
object
required
Payment methods to configure for invoices created from the template.
boolean
required
Must be true to confirm this changes payment options on the invoice template. Not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
Fixed provider tenant discriminator.
string
required
Invoice Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_CREATE_FAQCreate an FAQ after explicit confirmation. Location PITs require knowledge-bases.write.

Input Parameters

string
required
FAQ answer.
string
required
FAQ question.
boolean
required
Must be true to confirm this knowledge-base change.
string
required
Knowledge base ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_CREATE_KNOWLEDGE_BASECreate a knowledge base after explicit confirmation. Location PITs require knowledge-bases.write.

Input Parameters

string
required
Knowledge base name.
string
Knowledge base description.
boolean
required
Must be true to confirm this knowledge-base change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_DELETE_FAQIdempotently delete an FAQ after explicit confirmation; deleting an already-deleted FAQ is treated as successful. Location PITs require knowledge-bases.write.

Input Parameters

string
required
Resource ID.
boolean
required
Must be true to confirm deleting this resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_DELETE_KNOWLEDGE_BASEDelete a knowledge base after explicit confirmation. Location PITs require knowledge-bases.write.

Input Parameters

boolean
required
Must be true to confirm deleting this knowledge base.
string
required
Knowledge base ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_DELETE_TRAINED_URLS_FOR_KNOWLEDGE_BASEIdempotently delete trained pages after explicit confirmation; repeated deletion may still report a positive deletedCount. Location PITs require knowledge-bases.write.

Input Parameters

array
required
Trained URL IDs to delete.
boolean
required
Must be true to confirm this knowledge-base change.
string
required
Knowledge base ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_DISCOVER_WEBSITEStart website discovery after explicit confirmation. Location PITs require knowledge-bases.write.

Input Parameters

string
required
Website URL to discover.
string ("Exact" | "Path" | "Domain")
required
Discovery scope.
boolean
required
Must be true to confirm this knowledge-base change.
string
required
Knowledge base ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_GET_ALL_WEBSITE_URLS_DATA_BY_KNOWLEDGE_BASEReturn one page of crawled website URLs. Location PITs require knowledge-bases.readonly.

Input Parameters

integer
Page number.
string
URL search text.
integer
Page number returned by a previous call.
integer
Records per page; HighLevel requires 10 or more.
string
required
Knowledge base ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_GET_CRAWLING_STATUS_FOR_LATEST_OPERATIONGet crawler operation status. Location PITs require knowledge-bases.readonly.

Input Parameters

string
required
Crawler operation ID.
string
required
Knowledge base ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_GET_KNOWLEDGE_BASE_BY_IDGet a knowledge base by ID. Location PITs require knowledge-bases.readonly.

Input Parameters

string
required
Knowledge base ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum knowledge bases to return.
string
Knowledge-base name search query.
string
Opaque next_cursor returned by the immediately previous call. HighLevel treats unknown IDs as the first page.
string
Last knowledge-base ID from the previous page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_LIST_FAQReturn one page of FAQs. Location PITs require knowledge-bases.readonly.

Input Parameters

integer
Maximum FAQs to return.
string
Opaque next_cursor returned by the immediately previous call. HighLevel treats unknown IDs as the first page.
string
Last FAQ ID from the previous page.
string
required
Knowledge base ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Discovered URL IDs to train.
string
required
Crawler operation ID.
boolean
required
Must be true to confirm this knowledge-base change.
string
required
Knowledge base ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_UPDATE_FAQUpdate an FAQ after explicit confirmation. Location PITs require knowledge-bases.write.

Input Parameters

string
required
FAQ ID.
string
required
FAQ answer.
string
required
FAQ question.
boolean
required
Must be true to confirm this knowledge-base change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_KNOWLEDGE_BASE_UPDATE_KNOWLEDGE_BASEUpdate a knowledge base after explicit confirmation. Location PITs require knowledge-bases.write.

Input Parameters

string
required
Knowledge base ID.
string
Updated knowledge base name.
string
Updated knowledge base description.
boolean
required
Must be true to confirm this knowledge-base change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional Facebook pagination cursor from a previous response, sent unchanged as next. Not accepted for Google or LinkedIn.
string ("INTEGRATION" | "AD_MANAGER")
Facebook or Google account source: INTEGRATION or AD_MANAGER. Not accepted for LinkedIn.
boolean
Optional LinkedIn draft-selection flag, sent as isDraft. Not accepted for Facebook or Google.
string ("facebook" | "google" | "linkedin")
required
Ad platform whose equivalent operation to call.
string ("true" | "false")
Optional Facebook fetch-all value, sent as fetchAll. Not accepted for Google or LinkedIn.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("AD_MANAGER" | "INTEGRATION")
Required Facebook or Google integration source, sent as type (for example, AD_MANAGER or INTEGRATION). Not accepted for LinkedIn.
array
Optional LinkedIn reporting fields, sent as a comma-separated fields value. Not accepted for Facebook or Google.
string
required
Required report end date for every platform, sent as endDate.
string ("facebook" | "google" | "linkedin")
required
Ad platform whose equivalent operation to call.
string ("ads" | "adsets" | "campaigns" | "adGroups" | "keywords" | "campaignGroups")
required
Reporting entity type. Facebook accepts ads, adsets, or campaigns; Google accepts campaigns, adGroups, keywords, or ads; LinkedIn accepts campaignGroups, campaigns, or ads.
string
required
Required report start date for every platform, sent as startDate.
string
For Facebook ads/adsets, the required Meta fbCampaignId from the campaigns listing, not the 24-character HighLevel campaign ID. Google ads/adGroups/keywords require a numeric Google Ads campaign ID. For LinkedIn this is an optional campaign filter.
string
LinkedIn campaign group ID, required when list_type is campaigns or ads and sent as campaignGroupId. Not accepted for Facebook or Google.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Custom field name.
string ("contact" | "opportunity")
Object model that owns the field.
array
Non-empty choices required for CHECKBOX, SINGLE_OPTIONS, MULTIPLE_OPTIONS, and RADIO fields.
number
Field position.
string ("TEXT" | "LARGE_TEXT" | "NUMERICAL" | "PHONE" | "MONETORY" | "CHECKBOX" | "SINGLE_OPTIONS" | "MULTIPLE_OPTIONS" | "FLOAT" | "DATE" | "TEXTBOX_LIST" | "FILE_UPLOAD" | "RADIO" | "SIGNATURE")
required
HighLevel custom field data type.
string
Optional placeholder text.
array
Accepted file extensions.
boolean
Whether multiple files are allowed.
number
Maximum number of files.
array
Options for a text-box-list field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_CREATE_CUSTOM_VALUECreate a custom value in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/customValues.write.

Input Parameters

string
required
Custom value name.
string
required
Custom value contents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the task
array
Assigned To
boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
array
At most one contact ID.
string
Description of the task
object
required
Complete recurrence rule. Monthly rules need dayOfMonth or dayOfWeek; weekly rules need dayOfWeek.
boolean
Create initial task or not

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_CREATE_TAGCreate a tag in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/tags.write.

Input Parameters

string
required
Tag name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_DELETE_CUSTOM_FIELDDelete a custom field from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/customFields.write.

Input Parameters

string
required
Custom field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_DELETE_CUSTOM_VALUEDelete a custom value from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/customValues.write.

Input Parameters

string
required
Custom value ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Recurring Task Id
boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_DELETE_TAGDelete a tag from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/tags.write.

Input Parameters

string
required
Tag ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of matching templates to skip.
string ("sms" | "email" | "whatsapp")
Template channel filter.
integer
Maximum templates to return.
integer
Value returned as next_cursor by the previous call.
boolean
Whether to include deleted templates.
string
required
HighLevel template-origin ID, not the Location ID. Obtain it from a template’s originId field or the template-management UI/API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_GET_CONVERSATION_CHANNELGet SMS or email channel providers configured for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations.readonly.

Input Parameters

string ("SMS" | "Email")
required
Conversation channel type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_GET_CUSTOM_FIELDGet one custom field from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/customFields.readonly.

Input Parameters

string
required
Custom field ID or field key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_GET_CUSTOM_FIELDSList custom fields owned by the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/customFields.readonly.

Input Parameters

string ("contact" | "opportunity" | "all")
Object model whose custom fields to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_GET_CUSTOM_VALUEGet one custom value from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/customValues.readonly.

Input Parameters

string
required
Custom value ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_GET_CUSTOM_VALUESList custom values owned by the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/customValues.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_GET_LOCATIONGet the Location bound to the connected HighLevel account. Location PITs must be provisioned with the HighLevel permission: locations.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_GET_LOCATION_TAGSList tags owned by the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/tags.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_GET_RECURRING_TASK_BY_IDGet a recurring task by ID from the connected HighLevel Location; tasks returned as deleted are reported as not found. Location PITs must be provisioned with the HighLevel permission: recurring-tasks.readonly.

Input Parameters

string
required
Recurring Task Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_GET_TAG_BY_IDGet one tag from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/tags.readonly.

Input Parameters

string
required
Tag ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_GET_TIMEZONESFetch the available timezones for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_TASK_SEARCHReturn one offset-based page of tasks from the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/tasks.readonly.

Input Parameters

integer
Number of matching tasks to skip.
integer
Maximum tasks to return.
string
Text to search for in tasks.
string
Opaque continuation cursor returned by the previous call.
boolean
Filter by completion state.
array
Contact IDs to match.
array
Assigned user IDs to match.
string
Optional business ID filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Custom field ID.
string
required
Custom field name.
string ("contact" | "opportunity")
Object model that owns the field.
number
Field position.
string
Optional placeholder text.
array
Accepted nonblank file extensions.
boolean
Whether multiple files are allowed.
number
Maximum number of files.
array
Options for a text-box-list field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_UPDATE_CUSTOM_VALUEUpdate a custom value in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/customValues.write.

Input Parameters

string
required
Custom value ID.
string
required
Custom value name.
string
required
Custom value contents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Recurring Task Id
string
Name of the task
array
Assigned To
boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
array
At most one contact ID.
string
Description of the task
object
Complete replacement recurrence rule. Monthly rules need dayOfMonth or dayOfWeek; weekly rules need dayOfWeek.
boolean
Create initial task or not

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_UPDATE_TAGRename a tag in the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/tags.write.

Input Parameters

string
required
New tag name.
string
required
Tag ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_LOCATIONS_UPLOAD_FILE_CUSTOM_FIELDSUpload a file to a custom field for the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permission: locations/customFields.write.

Input Parameters

string
required
ID of the FILE_UPLOAD custom field.
object
required
File to upload to the target HighLevel custom field.
string
required
Maximum number of files as a numeric string, for example 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_MARKETPLACE_CHECK_WALLET_FUNDSCheck whether the connected HighLevel sub-account has sufficient wallet funds to be charged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Price per unit to charge.
number
required
Number of units to charge.
string
required
App ID of the Marketplace app.
string
User ID associated with the charge.
string
required
Unique event or transaction ID from the caller’s system.
string
required
Billing meter ID from the app’s pricing page.
string
ISO 8601 time when the billed event occurred; omit to use billing time.
string
required
Description of the wallet charge.
boolean
required
Must be true to confirm this creates a real charge against the connected Location’s wallet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_MARKETPLACE_DELETE_WALLET_CHARGEDelete a wallet charge. This is a destructive billing operation with real wallet consequences and requires explicit confirmation.

Input Parameters

string
required
ID of the wallet charge to delete.
boolean
required
Must be true to confirm deletion and its real wallet billing consequences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_MARKETPLACE_GET_INSTALLER_DETAILSGet company, Location, user, and installation details associated with the current HighLevel OAuth token for an app.

Input Parameters

string
required
Marketplace application ID. It is exposed as marketplaceAppId on a shipping carrier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_MARKETPLACE_GET_REBILLING_CONFIGGet the subscription and usage rebilling plans for an app in the connected HighLevel Location. HighLevel marks this endpoint deprecated.

Input Parameters

string
required
Marketplace application ID. It is exposed as marketplaceAppId on a shipping carrier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_MARKETPLACE_GET_WALLET_CHARGEGet the details of one HighLevel wallet charge by charge ID.

Input Parameters

string
required
ID of the wallet charge to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_MARKETPLACE_LIST_WALLET_CHARGESReturn one page of wallet charges visible to the connected HighLevel Location, with optional billing and date filters.

Input Parameters

integer
Number of matching charges to skip.
integer
Maximum number of charges to return.
string
Opaque continuation cursor returned by the previous call.
string
Caller-supplied user ID to filter by.
string
Return charges before this date.
string
Event or transaction ID to filter by.
string
Billing meter ID to filter by.
string
Return charges after this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the Marketplace application to uninstall.
string
Reason for uninstalling the application.
boolean
required
Must be true to confirm removal of the app’s access and functionality from the connected Location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("deleted" | "trashed")
required
Deletion state to apply.
boolean
required
Must be true to confirm the listed media objects may become unavailable. Not sent to HighLevel.
array
required
Files and folders to delete or trash; each object must contain a non-blank _id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_MEDIAS_BULK_UPDATE_MEDIA_OBJECTSRename multiple files or folders in the connected Location’s media storage; review per-item results for errors. Location PITs must be provisioned with the HighLevel permission medias.write.

Input Parameters

array
required
Files and folders to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_MEDIAS_CREATE_MEDIA_FOLDERCreate a folder in the connected Location’s media storage. Location PITs must be provisioned with the HighLevel permission: medias.write.

Input Parameters

string
required
Name of the folder to create.
string
Optional parent folder ID; omit to create a root folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_MEDIAS_DELETE_MEDIA_CONTENTDelete a file or folder from the connected HighLevel location’s media storage. Location PITs must be provisioned with the HighLevel permission: medias.write.

Input Parameters

string
required
ID of the file or folder to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_MEDIAS_FETCH_MEDIA_CONTENTFetch files and folders from the connected HighLevel location’s media storage. Location PITs must be provisioned with the HighLevel permission: medias.readonly.

Input Parameters

string ("file" | "folder")
required
Type of media objects to return.
integer
Maximum number of media objects to return.
string
Text used to search media objects.
string
Continuation cursor returned by a previous call.
integer
Number of media objects to skip.
string ("createdAt" | "updatedAt" | "name")
required
Field used to sort the media listing.
boolean
Whether to include all matching files or folders.
string
Parent folder ID used to restrict the listing.
string ("asc" | "desc")
required
Direction used to sort the media listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_MEDIAS_UPDATE_MEDIA_OBJECTRename one file or folder in the connected Location’s media storage. Location PITs must be provisioned with the HighLevel permission: medias.write.

Input Parameters

string
required
ID of the file or folder to update.
string
required
New file or folder name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_MEDIAS_UPLOAD_MEDIA_CONTENTUpload a file or import a hosted file into HighLevel media storage. Location PITs must be provisioned with the HighLevel permission: medias.write.

Input Parameters

object
File to upload. Non-video files may be up to 25 MB and videos up to 500 MB.
string
Name to assign to the uploaded media object.
boolean
Set true to import an already-hosted file from file_url instead of uploading file bytes.
string
Public file URL to import when hosted is true.
string
ID of the parent media folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Record payload requires 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.
string
required
Custom or standard object schema key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OBJECTS_DELETE_OBJECT_RECORDPermanently delete a business or custom object record by ID. Location PITs must be provisioned with the HighLevel permission: objects/record.write.

Input Parameters

string
required
Record ID to delete.
string
required
Custom or standard object schema key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OBJECTS_GET_OBJECT_BY_LOCATION_IDList standard and custom object schemas for the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: objects/schema.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OBJECTS_GET_OBJECT_SCHEMA_BY_KEYRetrieve an object schema by key or ID, optionally including its fields. Location PITs must be provisioned with the HighLevel permission: objects/schema.readonly.

Input Parameters

string
required
Custom or standard object key. Custom object keys include the custom_objects. prefix.
boolean
Set to true to include the object’s standard and custom fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OBJECTS_GET_RECORD_BY_IDRetrieve a business or custom object record by ID. Location PITs must be provisioned with the HighLevel permission: objects/record.readonly.

Input Parameters

string
required
Record ID.
string
required
Custom or standard object schema key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
One-based result page number.
string
Plain search term matched against the object’s configured searchable properties.
integer
Maximum records to return on the page.
string
Custom or standard object schema key. Required on the first page and restored from the cursor later.
string
Opaque cursor returned by a previous call. It restores the search context.
array
Provider continuation values for the first page; pass an empty list when starting a search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Standard or custom object key. Custom object keys must include the custom_objects. prefix; standard keys may be used to update searchable fields.
object
Updated singular and plural display labels for a custom object.
string
Updated custom-object description.
array
required
Complete list of fully qualified field keys that should be searchable for the standard or custom object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Record ID to update.
object
required
Record fields to update, using the fully qualified property keys and value types defined by the selected standard or custom object schema.
string
required
Standard or custom object schema key. Custom object keys must include the custom_objects. prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Opportunity Id
array
required
Array of user IDs to add or remove as followers (max 10)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the opportunity
string ("open" | "won" | "lost" | "abandoned")
required
Initial opportunity status.
string
required
Identifier of the contact linked to the opportunity
string
Identifier of the user the opportunity is assigned to
string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
required
pipeline Id
array
Add custom fields to opportunities.
number
Monetary value of the opportunity
string
Identifier of the pipeline stage
number
Forecast probability
string
Expected close date. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, or ISO 8601

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique pipeline name within the connected location.
array
required
One or more uniquely named pipeline stages. Every stage requires name and position; set each stage’s showInFunnel and showInPieChart explicitly because pipeline-level visibility flags do not propagate to stages.
boolean
required
Must be true to confirm creation of this pipeline. Not sent to HighLevel.
boolean
Whether to show the pipeline in the funnel view.
string ("dot" | "bg-tint" | "none")
Pipeline and stage color rendering mode.
boolean
Whether to show the pipeline in the pie chart view.
boolean
Enable manual stage-level win probabilities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OPPORTUNITIES_DELETE_OPPORTUNITYDelete Opportunity. This destructive change may be irreversible; confirm the target ID and intended outcome first. Location PITs must be provisioned with the HighLevel permission: opportunities.write.

Input Parameters

string
required
Opportunity Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique pipeline ID.
boolean
required
Must be true to confirm permanent deletion of the pipeline and all its opportunities. Not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OPPORTUNITIES_GET_LOST_REASONGet lost reason. Location PITs must be provisioned with the HighLevel permission: opportunities.readonly.

Input Parameters

string
lost reason name
integer
Number of lost reasons to skip.
integer
Maximum lost reasons to return.
string
search query
string
Opaque continuation cursor returned by the previous call.
boolean
deleted
boolean
get count

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OPPORTUNITIES_GET_OPPORTUNITYGet Opportunity. Location PITs must be provisioned with the HighLevel permission: opportunities.readonly.

Input Parameters

string
required
Opportunity Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OPPORTUNITIES_GET_PIPELINERetrieve one pipeline, including its stages and configuration. Location PITs must have pipelines.readonly.

Input Parameters

string
required
Unique pipeline ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OPPORTUNITIES_GET_PIPELINESGet Pipelines. Location PITs must be provisioned with the HighLevel permission: opportunities.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OPPORTUNITIES_REMOVE_FOLLOWERS_OPPORTUNITYAllows removal of one or all followers from an opportunity. Location PITs must be provisioned with the HighLevel permission: opportunities.write.

Input Parameters

string
required
Opportunity Id
array
required
Array of user IDs to add or remove as followers (max 10)
boolean
Set to true to remove all followers from the opportunity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
1-based page number (0 behaves like 1). Omit when using cursor.
integer
Maximum number of results to return per page
string
Full-text search query string (max 75 characters)
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.
string
Tenant identifier supplied by the connected account; caller values are overwritten.
array
Search-after cursor values for deep pagination
object
Flags to include additional related entities in the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OPPORTUNITIES_SEARCH_OPPORTUNITYSearch Opportunity. Location PITs must be provisioned with the HighLevel permission: opportunities.readonly.

Input Parameters

string
Search query (max 75 characters)
string
Opportunity Id
string
Start date in MM-DD-YYYY format or epoch milliseconds.
integer
1-based page number. Omit when using cursor.
integer
Limit Per Page records count. will allow maximum up to 100 and default will be 20
string ("added_asc" | "added_desc" | "name_asc" | "name_desc")
Sort order for results (e.g. added_asc, added_desc, name_asc, name_desc)
string
Opaque continuation cursor returned by the previous call.
string ("open" | "won" | "lost" | "abandoned" | "all")
Filter by opportunity status
string
Filter by country code (ISO 3166-1 alpha-2)
string
End date in MM-DD-YYYY format or epoch milliseconds.
boolean
get Notes in contact
boolean
get Tasks in contact
string
Contact Id
string
Filter by assigned user identifier
string
Campaign Id
string
Pipeline Id
string
Start After
string
Start After Id
string
Stage Id
boolean
get Calender event in contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OPPORTUNITIES_UPDATE_OPPORTUNITYUpdate Opportunity. Location PITs must be provisioned with the HighLevel permission: opportunities.write.

Input Parameters

string
required
Opportunity Id
string
Name of the opportunity
string ("open" | "won" | "lost" | "abandoned")
New opportunity status. Omit to leave status unchanged.
string
Identifier of the user the opportunity is assigned to
string
pipeline Id
array
Update custom fields to opportunities.
number
Monetary value of the opportunity
string
Identifier of the pipeline stage
number
Forecast probability
string
Expected close date. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, or ISO 8601

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OPPORTUNITIES_UPDATE_OPPORTUNITY_STATUSUpdate Opportunity Status. Location PITs must be provisioned with the HighLevel permission: opportunities.write.

Input Parameters

string
required
Opportunity Id
string ("open" | "won" | "lost" | "abandoned")
required
New opportunity status.
string
Existing HighLevel lost-reason ID; required only when assigning that reason.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Unique pipeline name. Every update must also include the full stages list.
array
required
Full replacement stage list. Every stage requires 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.
string
required
Unique pipeline ID.
boolean
required
Must be true because replacing stages can migrate opportunities. Not sent to HighLevel.
boolean
Whether to show the pipeline in the funnel view.
string ("dot" | "bg-tint" | "none")
Pipeline and stage color rendering mode.
boolean
Whether to show the pipeline in the pie chart view.
boolean
Enable manual stage-level win probabilities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_OPPORTUNITIES_UPSERT_OPPORTUNITYUpsert Opportunity. Location PITs must be provisioned with the HighLevel permission: opportunities.write.

Input Parameters

string
opportunityId
string
name
string ("open" | "won" | "lost" | "abandoned")
Opportunity status to write. Omit to preserve status when updating.
array
User IDs to add to or remove from the contact’s followers; HighLevel does not apply these followers to the opportunity itself.
string
required
Contact ID that owns the opportunity.
string
Identifier of the user the opportunity is assigned to
string
Tenant identifier supplied by the connected account; caller values are overwritten.
string
required
pipeline Id
string
lost reason Id
number
Monetary value of the opportunity
string
Identifier of the pipeline stage
number
Forecast probability
string ("add" | "remove")
Followers action type.
boolean
Whether to remove every follower.
string
Expected close date. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, or ISO 8601

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_CREATE_COUPONCreate a promotional coupon for the connected Location; future-payment configuration requires the future-payments flag to be true. Location PITs must be provisioned with the HighLevel permission: payments/coupons.write.

Input Parameters

string
required
Coupon redemption code.
string
required
Coupon name.
string
Connected Location ID; caller values are overwritten.
string
Fixed Location tenant type.
string
Optional end date in ISO 8601 format.
array
Eligible price IDs.
string
required
Start date in ISO 8601 format.
array
Eligible product IDs.
integer
Maximum total redemptions.
array
Eligible variant IDs.
string ("percentage" | "amount")
required
Discount type.
number
required
Discount percentage or fixed amount.
boolean
Limit redemption to once per customer.
boolean
Apply to future subscription payments.
object
Future-payment duration configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Custom payment provider name.
string
required
Public provider logo URL.
string
required
Public URL for verify, refund, and subscription events.
string
required
Provider description shown in payment integrations.
string
required
Public payment-session iframe URL.
boolean
required
Whether subscription schedules are supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Provider display title.
string
Connected Location ID; caller values are overwritten.
string
Fixed Location tenant type.
string ("authorize-net" | "nmi")
required
Underlying payment provider.
string
required
Public HTTPS provider image URL.
string
required
Provider description.
string
required
Unique lowercase provider name using letters and hyphens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Items and quantities being fulfilled.
string
Connected Location ID; caller values are overwritten.
string
Fixed Location tenant type.
string
required
Order ID to fulfill.
array
required
Fulfillment tracking records.
boolean
required
Whether HighLevel should notify the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional company ID; the connected Location ID is always supplied.
string
Connected Location ID; caller values are overwritten.
boolean
required
Whether the marketplace app supports subscription schedules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_DELETE_COUPONPermanently delete a coupon. This cannot be undone; confirm the exact coupon ID and that no active promotion should continue before calling. Location PITs must be provisioned with the HighLevel permission: payments/coupons.write.

Input Parameters

string
required
Coupon ID to permanently delete.
string
Connected Location ID; caller values are overwritten.
string
Fixed Location tenant type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_DELETE_INTEGRATIONPermanently delete the connected Location’s custom payment-provider association; this can stop payment processing. Location PITs must be provisioned with the HighLevel permission: payments/custom-provider.write.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
True to disconnect live payment processing; false to disconnect test mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_FETCH_CONFIGFetch the custom payment-provider configuration for the connected Location. A traceId-only response means no custom provider is configured. Location PITs must be provisioned with the HighLevel permission: payments/custom-provider.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Coupon ID.
string
required
Coupon redemption code required by the endpoint; HighLevel currently selects by id and ignores this value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_GET_ORDER_BY_IDRetrieve one order by ID from the connected Location. Location PITs must be provisioned with the HighLevel permission: payments/orders.readonly.

Input Parameters

string
required
Order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_GET_SUBSCRIPTION_BY_IDRetrieve one payment subscription by ID from the connected Location. Location PITs must be provisioned with the HighLevel permission: payments/subscriptions.readonly.

Input Parameters

string
required
Subscription ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_GET_TRANSACTION_BY_IDRetrieve one payment transaction by ID from the connected Location. Location PITs must be provisioned with the HighLevel permission: payments/transactions.readonly.

Input Parameters

string
required
Transaction ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_LIST_COUPONSReturn one offset page of coupons for the connected Location. Location PITs must be provisioned with the HighLevel permission: payments/coupons.readonly.

Input Parameters

integer
Maximum coupons on this page.
string
Opaque continuation cursor returned by the previous call.
integer
Zero-based coupon offset.
string
Coupon code search text; coupon names are not matched.
string ("scheduled" | "active" | "expired")
Coupon status filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_LIST_INTEGRATION_PROVIDERSReturn one offset page of white-label payment integration providers for the connected Location. Location PITs must be provisioned with the HighLevel permission: payments/integration.readonly.

Input Parameters

integer
Maximum providers on this page.
string
Opaque continuation cursor returned by the previous call.
integer
Zero-based provider offset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_LIST_ORDER_FULFILLMENTList fulfillment history for one order in the connected Location. Location PITs must be provisioned with the HighLevel permission: payments/orders.readonly.

Input Parameters

string
required
Order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_LIST_ORDER_NOTESList notes for one payment order in the connected Location. Location PITs must be provisioned with the HighLevel permission: payments/orders.readonly.

Input Parameters

string
required
Order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_LIST_ORDERSReturn one offset page of orders for the connected Location. altType is fixed to the live-required value location. Location PITs must be provisioned with the HighLevel permission: payments/orders.readonly.

Input Parameters

integer
Maximum orders on this page.
string
Opaque continuation cursor returned by the previous call.
string
End date in YYYY-MM-DD format.
integer
Zero-based order offset.
string
Order name search text.
string
Order status filter.
string
Start date in YYYY-MM-DD format.
string
Order source ID.
string
Contact ID filter.
string
Payment mode filter.
string ("paid" | "unpaid" | "refunded" | "partially_paid")
Payment status filter.
string
Comma-separated funnel product IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_LIST_SUBSCRIPTIONSReturn one offset page of subscriptions for the connected Location. Location PITs must be provisioned with the HighLevel permission: payments/subscriptions.readonly.

Input Parameters

string
Subscription ID filter.
integer
Maximum subscriptions on this page.
string
Opaque continuation cursor returned by the previous call.
string
End date in YYYY-MM-DD format.
integer
Zero-based subscription offset.
string
Subscription name search text.
string
Start date in YYYY-MM-DD format.
string
Entity ID filter.
string
Contact ID filter.
string
Payment mode filter.
string
Subscription source type.
boolean
Include collected-payment count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_LIST_TRANSACTIONSReturn one offset page of payment transactions for the connected Location. Location PITs must be provisioned with the HighLevel permission: payments/transactions.readonly.

Input Parameters

integer
Maximum transactions on this page.
string
Opaque continuation cursor returned by the previous call.
string
End date in YYYY-MM-DD format.
integer
Zero-based transaction offset.
string
Transaction name search text.
string
Start date in YYYY-MM-DD format.
string
Entity ID filter.
string
Contact ID filter.
string
Payment mode filter.
string
Subscription ID filter.
string
Transaction source type.
string
Transaction source subtype.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Optional receipt details: brand, type, and last4.
object
Payment metadata.
string ("cash" | "card" | "cheque" | "bank_transfer" | "other")
required
Manual payment method.
string
Payment note.
string
Connected Location ID; caller values are overwritten.
number
Amount to record; verify currency and units before calling.
object
Optional receipt details containing the cheque number.
string
Fixed Location tenant type.
string
required
Order ID to mark paid or partially paid.
boolean
Whether this is a partial payment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PAYMENTS_UPDATE_COUPONReplace an existing coupon’s promotional terms; future-payment configuration requires future payments to be enabled. Location PITs must be provisioned with the HighLevel permission payments/coupons.write.

Input Parameters

string
required
Coupon ID to update.
string
required
Coupon redemption code.
string
required
Coupon name.
string
Connected Location ID; caller values are overwritten.
string
Fixed Location tenant type.
string
Optional end date in ISO 8601 format.
array
Eligible price IDs.
string
required
Start date in ISO 8601 format.
array
Eligible product IDs.
integer
Maximum total redemptions.
array
Eligible variant IDs.
string ("percentage" | "amount")
required
Discount type.
number
required
Discount percentage or fixed amount.
boolean
Limit redemption to once per customer.
boolean
Apply to future subscription payments.
object
Future-payment duration configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Zero-based page index.
integer
Maximum active numbers to return (1-1000).
string
Filter active numbers by number text.
boolean
Exclude numbers assigned to number pools.
boolean
Include RCS sender IDs in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PHONE_SYSTEM_GET_NUMBER_POOL_LISTList number pools for the connected HighLevel location. This action requires the location’s external phone-system state to be configured. Location PITs must be provisioned with the HighLevel permission: numberpools.read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional digits that may occur anywhere in the phone number.
string
Optional digits at the end of the phone number.
string
Optional digits at the beginning of the phone number.
boolean
required
Require MMS capability.
boolean
required
Require SMS capability.
string
required
Two-letter uppercase country code in which to search for numbers.
array
required
Phone-number types to search for.
boolean
required
Require voice capability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Twilio regulatory bundle ID, when the country or number requires one.
string
Twilio regulatory address ID, when the country or number requires one.
string ("local" | "mobile" | "tollFree")
Optional type of phone number to purchase.
string
Optional country code for the requested phone number.
string
required
Phone number to purchase.
string
required
fingerprintId returned by PHONE_SYSTEM_LIST_AVAILABLE_NUMBERS_FOR_ACOUNTRY for the search that found this number.
boolean
required
Must be true to confirm the purchase may immediately charge the configured payment method. This toolkit surface has no action for releasing the number.
boolean
Whether to skip location-level KYC. Leave false unless agency-level regulatory compliance is already verified; an incorrect true value can cause HighLevel to reject the purchase.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Products and nested prices to edit. HighLevel permits at most 30 total product and price entities.
boolean
required
Must be true to confirm the bulk product and price changes. This value is not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("bulk-update-price" | "bulk-update-availability" | "bulk-update-product-collection" | "bulk-delete-products" | "bulk-update-currency")
required
Type of bulk update operation
object
Price update configuration
object
Filters used with selectAll: collectionIds, productType, availableInStore, and search.
string
Currency code
array
required
Non-empty array of product IDs
boolean
New availability status
array
Non-empty array of collection IDs to add. This operation never removes existing collections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PRODUCTS_BULK_UPDATE_PRODUCT_REVIEWUpdate the status of one or multiple product reviews to approved or pending. Location PITs must be provisioned with the HighLevel permission products.write.

Input Parameters

string ("approved" | "pending")
required
Status of the review
array
required
Non-empty array of product reviews.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The unique identifier of the SKU associated with the price
object
Additional metadata associated with the price.
string
required
The name of the price.
string ("one_time" | "recurring")
required
The type of the price.
number
required
The amount of the price. ( min: 0 )
string
The unique identifier of the user who created the price.
string
required
The currency of the price.
object
The recurring details of the price (if type is recurring).
number
The setup fee for the price.
string
required
ID of the product that needs to be used
string
A brief description of the price.
number
The total number of billing cycles for the price. ( min: 1 )
number
The trial period duration in days (if applicable).
boolean
Need to track inventory stock quantity
number
The compare at price for the price.
array
Digital delivery objects with id, name, type, url, and size when required.
object
Shipping options of the Price
array
An array of membership offers associated with the price.
number
Available inventory stock quantity
boolean
Is the product a digital product
array
An array of variant option IDs associated with the price.
boolean
Continue selling when out of stock

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
SEO preview fields: title and description.
string
required
The name of the product.
string
The slug using which the product navigation will be handled
string
The URL for the product image.
object
Product label with required title and optional startDate and endDate.
array
List of ids of Taxes attached to the Product. If taxes are passed, isTaxesEnabled should be true.
array
An array of medias for the product.
array
An array of variants for the product.
string
A brief description of the product.
string ("DIGITAL" | "PHYSICAL" | "SERVICE" | "PHYSICAL/DIGITAL")
required
Product type used to determine physical, digital, or service behavior.
boolean
Whether the taxes should be included in the purchase price
array
An array of category Ids for the product
boolean
Is the product label enabled. If this is true, label object cannot be empty.
boolean
Are there any taxes attached to the product. If this is true, taxes array cannot be empty.
boolean
Indicates whether the product is available in-store.
string
The statement descriptor for the product.
string
Tax category ID for Automatic taxes calculation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PRODUCTS_CREATE_PRODUCT_COLLECTIONCreate a new Product Collection for a specific location Location PITs must be provisioned with the HighLevel permission: products/collection.write.

Input Parameters

object
The metadata information which will be displayed in SEO previews
string
required
Name of the Product Collection
string
required
Slug of the Product Collection which helps in navigation
string
The URL of the image that is going to be displayed as the collection Thumbnail
string
Unique Identifier of the Product Collection, Mongo Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the price that needs to be returned
string
required
ID of the product that needs to be used

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Product ID (24-character hexadecimal Mongo ID); slugs are not accepted.
boolean
Parameter which will decide whether to show the wishlisting status of products

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PRODUCTS_DELETE_PRODUCT_COLLECTIONDelete specific product collection with Id :collectionId Location PITs must be provisioned with the HighLevel permission: products/collection.write.

Input Parameters

string
required
MongoId of the collection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PRODUCTS_DELETE_PRODUCT_REVIEWDelete specific product review Location PITs must be provisioned with the HighLevel permission: products.write.

Input Parameters

string
required
Review Id
string
required
Product Id of the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The maximum number of items to be included in a single page of results
integer
Continuation offset returned as next_cursor by the previous call.
integer
The starting index of the page, indicating the position from which the results should be retrieved.
string
Search string for Variant Search

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the price that needs to be returned
string
required
ID of the product that needs to be used

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Product ID (24-character hexadecimal Mongo ID); slugs are not accepted.
boolean
Parameter which will decide whether to show the wishlisting status of products

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Query to search collection based on names
integer
The maximum number of items to be included in a single page of results
integer
Continuation offset returned as next_cursor by the previous call.
integer
The starting index of the page, indicating the position from which the results should be retrieved.
string
Ids of the collections separated by comma(,) for search purposes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PRODUCTS_GET_PRODUCT_COLLECTION_IDGet Details about individual product collection Location PITs must be provisioned with the HighLevel permission: products/collection.readonly.

Input Parameters

string
required
Collection Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The maximum number of items to be included in a single page of results
integer
The starting index of the page, indicating the position from which the results should be retrieved.
number
Key to filter the ratings
string ("pending" | "approved")
required
Moderation status of reviews to return.
string
The end date for filtering reviews
string
Comma-separated list of store IDs
string
Comma-separated list of product IDs
string ("createdAt" | "rating")
The field upon which the sort should be applied
string ("asc" | "desc")
The order of sort which should be applied for the sortField
string
The start date for filtering reviews

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The name of the product for searching.
string
required
ID of the store funnel (_id from the funnel list where isStoreActive is true), not a page or step ID.
string
Filter by product collection Ids. Supports comma separated values

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PRODUCTS_GET_REVIEWS_COUNTAPI to fetch the Review Count as per status Location PITs must be provisioned with the HighLevel permission: products.readonly.

Input Parameters

number
Key to filter the ratings
string
The end date for filtering reviews
string
Comma-separated list of store IDs
string
Comma-separated list of product IDs
string
The start date for filtering reviews

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
To filter the response only with the given price ids, Please provide with comma separated
integer
The maximum number of items to be included in a single page of results
integer
Continuation offset returned as next_cursor by the previous call.
integer
The starting index of the page, indicating the position from which the results should be retrieved.
string
required
ID of the product that needs to be used

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The maximum number of items to be included in a single page of results
integer
Continuation offset returned as next_cursor by the previous call.
array
Name of an entity whose data has to be fetched along with product. Possible entities are tax, stripe and paypal. If not mentioned, only ID will be returned in case of taxes
integer
The starting index of the page, indicating the position from which the results should be retrieved.
string
The name of the product for searching.
string
fetch and project products based on the storeId
string ("asc" | "desc")
The order of sort which should be applied for the date
array
List of product ids to be fetched.
string
Filter by product category Ids. Supports comma separated values
string
The slug value of the collection by which the collection would be searched
boolean
Separate products by which are included in the store and which are not
boolean
If the product is included in the online store

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Products and their display priorities.
string
required
ID of the store funnel (_id from the funnel list where isStoreActive is true), not a page or step ID.
boolean
required
Must be true to confirm reordering products in the store. Not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Non-empty array of items to update in the inventory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The unique identifier of the SKU associated with the price
object
Additional metadata associated with the price.
string
required
The name of the price.
string ("one_time" | "recurring")
required
The type of the price.
number
required
The amount of the price. ( min: 0 )
string
The unique identifier of the user who created the price.
string
required
The currency of the price.
string
required
ID of the price that needs to be returned
object
The recurring details of the price (if type is recurring).
number
The setup fee for the price.
string
required
ID of the product that needs to be used
string
A brief description of the price.
number
The total number of billing cycles for the price. ( min: 1 )
number
The trial period duration in days (if applicable).
boolean
Need to track inventory stock quantity
number
The compare at price for the price.
array
Digital delivery objects with id, name, type, url, and size when required.
object
Shipping options of the Price
array
An array of membership offers associated with the price.
number
Available inventory stock quantity
boolean
Is the product a digital product
array
An array of variant option IDs associated with the price.
boolean
Continue selling when out of stock

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
SEO preview fields: title and description.
string
required
The name of the product.
string
The slug using which the product navigation will be handled
string
The URL for the product image.
object
Product label with required title and optional startDate and endDate.
array
List of ids of Taxes attached to the Product. If taxes are passed, isTaxesEnabled should be true.
array
An array of medias for the product.
array
An array of variants for the product.
string
required
Product ID (24-character hexadecimal Mongo ID); slugs are not accepted.
string
A brief description of the product.
string ("DIGITAL" | "PHYSICAL" | "SERVICE" | "PHYSICAL/DIGITAL")
required
Requested product type. HighLevel ignores this field on update and recomputes productType from the product’s prices.
boolean
Whether the taxes should be included in the purchase price
array
An array of category Ids for the product
boolean
Is the product label enabled. If this is true, label object cannot be empty.
boolean
Are there any taxes attached to the product. If this is true, taxes array cannot be empty.
boolean
Indicates whether the product is available in-store.
string
The statement descriptor for the product.
string
Tax category ID for Automatic taxes calculation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PRODUCTS_UPDATE_PRODUCT_COLLECTIONUpdate a specific product collection with Id :collectionId Location PITs must be provisioned with the HighLevel permission: products/collection.write.

Input Parameters

object
The metadata information which will be displayed in SEO previews
string
Name of the Product Collection
string
Slug of the Product Collection which helps in navigation
string
The URL of the image that is going to be displayed as the collection Thumbnail
string
required
MongoId of the collection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_PRODUCTS_UPDATE_PRODUCT_REVIEWUpdate status, reply, etc of a particular review Location PITs must be provisioned with the HighLevel permission: products.write.

Input Parameters

array
Reply of the review
string
Detailed Review of the product
number
Rating of the product
string ("approved" | "pending")
required
Status of the review
string
Headline of the Review
string
required
Review Id
string
required
Product Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("include" | "exclude")
required
Action to include or exclude the product from the store
string
required
ID of the store funnel (_id from the funnel list where isStoreActive is true), not a page or step ID.
array
required
Non-empty array of non-empty product IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of matching documents to skip.
integer
Maximum documents to return on this page.
string
Text to search for in documents.
string
Opaque continuation cursor returned by the previous call.
string ("draft" | "sent" | "viewed" | "completed" | "accepted")
Document status to match.
string
Inclusive ISO 8601 end time; requires date_from.
string
Inclusive ISO 8601 start time; requires date_to.
string ("waiting_for_payment" | "paid" | "no_payment")
Payment status to match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Template name to match.
integer
Number of matching templates to skip.
string
Comma-separated template types: proposal, estimate, or contentLibrary.
integer
Number of templates to return on this page.
string
Opaque continuation cursor returned by the previous call.
string
Inclusive ISO 8601 end time; requires date_from.
string
User identifier; required for public document forms.
string
Inclusive ISO 8601 start time; requires date_to.
boolean
Filter for public document forms.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("link" | "email")
Provider delivery medium. email sends an external email; link requests link delivery.
string
required
HighLevel user identifier recorded as the sender.
string
required
Document identifier to send.
string
Connected HighLevel Location ID; caller-supplied values are ignored.
array
Additional external recipients copied on the send.
string
Optional document name.
object
Sender and recipient notification configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
HighLevel user identifier creating the document.
string
required
Contact that will receive or own the document.
string
Connected HighLevel Location ID; caller-supplied values are ignored.
string
required
Template identifier to instantiate.
boolean
Whether HighLevel should send the created document externally. Set true only after confirming the contact and template; sending is irreversible. Omitted uses HighLevel’s default and sends; pass false to create a draft.
string
Opportunity to associate with the created document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional LinkedIn q search term. Not accepted for Facebook or Google.
string ("geolocation" | "interest" | "language")
Required target taxonomy for Facebook and Google. Facebook accepts geolocation, interest, or language; Google accepts geolocation or language. Not accepted for LinkedIn.
string
Required LinkedIn targeting facet, sent as facet. Not accepted for Facebook or Google.
string
Targeting search text, sent as query. Required for Facebook, optional for Google and LinkedIn.
string ("facebook" | "google" | "linkedin")
required
Ad platform whose equivalent operation to call.
string
Optional Facebook targeting search subtype, sent as searchType. Not accepted for Google or LinkedIn.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
LinkedIn person or organization URN.
string
Name of the Facebook page or account
string ("page" | "group" | "profile" | "location" | "business")
Provider account type returned by the account lookup.
string
Avatar or profile picture URL
object
Google Business Profile account returned by the account lookup.
boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
Facebook Page ID required for an Instagram account.
object
Google Business Profile location returned by the account lookup.
string ("google" | "facebook" | "instagram" | "linkedin" | "tiktok" | "youtube" | "pinterest" | "threads" | "bluesky")
required
Social media platform (must match the platform used in Steps 1 and 2)
string
Pinterest profile username.
boolean
Pinterest profile verification status.
string
Original Facebook platform identifier
string
required
The OAuth Account ID received from Step 1 (same as used in Step 2)
string
Pinterest company identifier.
string
Pinterest profile website URL.
string
Pinterest source account type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_BULK_DELETE_POSTSIdempotently soft-delete up to 50 Social Planner posts from HighLevel. Repeating a deletion may report the same count again, and SOCIAL_PLANNER_GET_POSTS does not list these records with its deleted filter. Confirm all post IDs before calling. The proven six-scope OAuth union is sufficient, but HighLevel does not map this endpoint to one individually necessary scope; no Social Planner-specific PIT permission was enforced by the minimal-PIT probe.

Input Parameters

array
required
Social Planner post IDs to delete from the HighLevel CRM database.
boolean
required
Must be true to confirm deletion of every listed post. This value is not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
required
Order for the cloned item (typically between source and next item)
boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Provider field itemId.
string
required
Provider field queueId.
string
required
Edit session ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Content of the comment. Per-platform max length: Facebook 8000, Instagram 2200, Linkedin 3000, Community 8000, Tiktok 150, Bluesky 300, Youtube 10000, Threads 500.
array
Mentions for the comment. Supported on: Facebook, LinkedIn, Community. Ignored on: Instagram, TikTok, Bluesky — the field is accepted but mentions are not rendered on these platforms.
string ("facebook" | "instagram" | "linkedin" | "community" | "tiktok" | "bluesky" | "youtube" | "threads")
required
Platform on which to create the comment
string
required
Required internal post ID for a top-level comment (isParentThread: true) or internal parent comment ID for a reply (isParentThread: false).
array
Attachments for the comment (max 1 image). Supported on: Facebook only. Not supported on: Instagram, LinkedIn, TikTok, Bluesky, Community — the field is accepted by the API but the attachment will not appear on the comment. (Community processes the field server-side, but external URLs are not rendered due to its bucket restriction.)
boolean
required
Set 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).
boolean
When 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Internal HighLevel comment ID returned as _id by list comments
boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string ("facebook" | "linkedin" | "community" | "tiktok" | "bluesky")
required
Platform on which to like the comment; Instagram is unsupported

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Array of Tag IDs to associate with the post for organization and filtering. Get Tag IDs from: Get Tags API use the _id field from each tag. Validation: All IDs must be valid MongoDB ObjectIds.
string ("post" | "story" | "reel")
required
Type of post to create. Determines the format and platform requirements. Available Types: - 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 Reels
array
Post Media Data The limitations of media as per the platforms is provided through the reference link in API description
string ("draft" | "scheduled" | "in_review" | "published" | "in_progress" | "pending" | "failed" | "notification_sent" | "deleted")
Post status. scheduled and in_review require schedule_date; every status, including draft, requires at least one account ID.
string
Post content/caption text. Character limits vary by platform. Custom Values & Hashtags: - You can include custom values/variables in the content (e.g., {{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 Guide
string
required
User ID of the user creating/managing the post. Required for OAuth channel posts (non-draft).
string
User ID of the creator who is creating/managing the post. Must be a valid MongoDB ObjectId. Get User IDs from: Get User API use the id field from the user object. Validation: Must be a valid MongoDB ObjectId.
array
required
One or more connected social account IDs. HighLevel requires a non-empty array for drafts and published or scheduled posts.
string
Category ID to organize the post. Categories help group related posts. Get Category IDs from: Get Categories API use the _id field. Validation: Must be a valid MongoDB ObjectId.
string
Location ID supplied by the connected account; caller values are overwritten.
string
Schedule Date
boolean
Apply watermark to media in this post. Note: Watermarks are applied to images only. Videos are not watermarked.
object
Open Graph link preview data. HighLevel stores metaImage, metaLink, and ogTitle; it accepts ogDescription but currently does not persist it.
object
GMB Post Details
string
Follow-up comment to be posted immediately after the main post is published. Supported Platforms: Facebook, Instagram, LinkedIn, YouTube NOT Supported: TikTok, Google My Business (GMB), Pinterest Use Case: Great for adding hashtags, additional context, or engagement prompts without cluttering the main post. - Follow-up comment is automatically trimmed to platform limits Reference: Platform Limitations Guide
string
Selected Best Time slot for scheduling
object
Tiktok Post Details
object
YouTube-specific post configuration. Key Fields: - 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 required
object
Facebook-specific post configuration. Key Fields: - type: 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 Guide
object
LinkedIn-specific post configuration. Key Fields: - postAsPdf: 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 Guide
object
Post Approval Details
boolean
Flag indicating if the schedule datetime was manually updated. Used for tracking rescheduled posts.
object
Instagram-specific post configuration. Key Fields: - type: 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 Guide
object
Pinterest-specific post configuration. Required when posting to Pinterest accounts. Required Fields: - boardIds: 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 Guide
boolean
Must be true unless status is draft, because this request may publish or schedule content on external social networks. This value is not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
User id
array
required
Publishing slots. Each slot uses Sunday=0 through Saturday=6 and a time in HH:MM format.
string
required
Category ID
boolean
Enable Future Posts. Defaults to false.
boolean
Prioritize New Content. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Order for the new item in the queue (cyclic-aware). Accepts: - A number: explicit order value calculated by FE as midpoint between adjacent items - “top”: place at cyclic top (first to be scheduled next) - “bottom”: place at cyclic bottom (last to be scheduled) For positions between items, FE calculates: Math.floor((prevItem.order + nextItem.order) / 2) Defaults to end if not provided. Note: This field is ignored when directToQueue is true - the order will be automatically calculated based on the queue’s prioritizeNewContent setting.
boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Provider field queueId.
string
Edit session ID
array
Platform-specific variations. Facebook posts without media need a variation with non-empty content.
string
Primary media URL (image) for the post. Falls back to modifiedPostPayload.primaryImage if not set.
boolean
When true, creates the queue item directly without requiring an edit session, even for active/paused queues. This flag is optional: omitting both it and sessionId can also create a live item. When true, order is ignored and placement follows the queue’s prioritizeNewContent setting.
object
Queued post details. accountIds and userId are required; media defaults to an empty array.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id
string
User ID
string
Location ID supplied by the connected account; caller values are overwritten.
boolean
required
Must be true to confirm disconnecting this external social-network account. This value is not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
CSV Id
string
Location ID supplied by the connected account; caller values are overwritten.
boolean
required
Must be true to confirm deletion of this imported CSV and its staged data. This value is not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
CSV Id
string
required
CSV Post Id
string
Location ID supplied by the connected account; caller values are overwritten.
boolean
required
Must be true to confirm deletion of this staged CSV post. This value is not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Provider field postId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Internal HighLevel comment ID returned as _id by list comments
boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string ("facebook" | "linkedin" | "community" | "tiktok" | "bluesky")
required
Platform on which to remove the comment like; Instagram is unsupported

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Post ID to soft-delete from Social Planner.
string
Location ID supplied by the connected account; caller values are overwritten.
boolean
required
Must be true to confirm deletion of this social post. This value is not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Provider field itemId.
string
required
Provider field queueId.
string
Edit session ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Provider field queueId.
string
required
Edit session ID
boolean
If true, keeps the queue in DRAFT state after saving instead of automatically activating it. Only applicable when the queue is currently in DRAFT status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Post Id
array
Array of Tag IDs to associate with the post for organization and filtering. Get Tag IDs from: Get Tags API use the _id field from each tag. Validation: All IDs must be valid MongoDB ObjectIds.
string ("post" | "story" | "reel")
required
Type of post to create. Determines the format and platform requirements. Available Types: - 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 Reels
array
Post Media Data The limitations of media as per the platforms is provided through the reference link in API description
string ("draft" | "scheduled" | "in_review" | "published" | "in_progress" | "pending" | "failed" | "notification_sent" | "deleted")
Post status indicating the current state of the post. Available Status Values: - draft - 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.
string
Post content/caption text. Character limits vary by platform. Custom Values & Hashtags: - You can include custom values/variables in the content (e.g., {{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 Guide
string
required
User ID of the user creating/managing the post. Required for OAuth channel posts (non-draft).
string
User ID of the creator who is creating/managing the post. Must be a valid MongoDB ObjectId. Get User IDs from: Get User API use the id field from the user object. Validation: Must be a valid MongoDB ObjectId.
array
required
Account IDs for the post. Required for every edit, including drafts; HighLevel validates that each ID is a connected account for the location.
string
Category ID to organize the post. Categories help group related posts. Get Category IDs from: Get Categories API use the _id field. Validation: Must be a valid MongoDB ObjectId.
string
Location ID supplied by the connected account; caller values are overwritten.
string
Schedule Date
boolean
Apply watermark to media in this post. Note: Watermarks are applied to images only. Videos are not watermarked.
object
Open Graph link preview data. HighLevel stores metaImage, metaLink, and ogTitle; it accepts ogDescription but currently does not persist it.
object
GMB Post Details
string
Follow-up comment to be posted immediately after the main post is published. Supported Platforms: Facebook, Instagram, LinkedIn, YouTube NOT Supported: TikTok, Google My Business (GMB), Pinterest Use Case: Great for adding hashtags, additional context, or engagement prompts without cluttering the main post. - Follow-up comment is automatically trimmed to platform limits Reference: Platform Limitations Guide
string
Selected Best Time slot for scheduling
object
Tiktok Post Details
object
YouTube-specific post configuration. Key Fields: - 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 required
object
Facebook-specific post configuration. Key Fields: - type: 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 Guide
object
LinkedIn-specific post configuration. Key Fields: - postAsPdf: 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 Guide
object
Post Approval Details
boolean
Flag indicating if the schedule datetime was manually updated. Used for tracking rescheduled posts.
object
Instagram-specific post configuration. Key Fields: - type: 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 Guide
object
Pinterest-specific post configuration. Required when posting to Pinterest accounts. Required Fields: - boardIds: 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 Guide
boolean
Must be true unless status is explicitly draft, because editing can republish content on external social networks. This value is not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Search query
integer
Number of items to skip
integer
Maximum number of items to return
string
Opaque continuation cursor returned by the previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_FETCH_CALENDAR_LISTReturns scheduled posts from active queues within a date range. Supports filtering by categories and accounts. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.readonly.

Input Parameters

string
required
End Date in ISO format
string
required
Start Date in ISO format
array
Filter by Account IDs. If not provided or empty, returns all posts.
string
Location ID supplied by the connected account; caller values are overwritten.
array
Category Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
End Date in ISO format
string
required
Provider path parameter queueId.
string
required
Edit session ID
string
required
Start Date in ISO format
array
Filter by Account IDs. If not provided or empty, returns all posts.
string
Location ID supplied by the connected account; caller values are overwritten.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Provider path parameter queueId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Number of items to skip
number
Maximum number of items to return
string
Continuation cursor returned by the previous call. Omit for the first page.
string
Item ID to center the response around. When provided, the response will position this item in the center with items above and below based on limit. The skip parameter is ignored when itemId is provided.
string
required
Provider path parameter queueId.
string
Edit session ID
string
Location ID supplied by the connected account; caller values are overwritten.
boolean
To return only queue items with errors

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_FETCH_QUEUESRetrieves a paginated list of all category queues for a given location, excluding any that have been marked as deleted. Location PITs must be provisioned with the HighLevel permission: socialplanner/category.readonly.

Input Parameters

number
Number of items to skip
number
Maximum number of items to return
string
Continuation cursor returned by the previous call. Omit for the first page.
string
Location ID supplied by the connected account; caller values are overwritten.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Number of items to skip
number
Number of items to return
string
Continuation cursor returned by the previous call. Omit for the first page.
string
required
Provider path parameter queueId.
string
Session ID for edit mode. If not provided, calculates slots for live items.
string
Location ID supplied by the connected account; caller values are overwritten.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_GET_ACCOUNTGet list of accounts and groups Location PITs must be provisioned with the HighLevel permission: socialplanner/account.readonly.

Input Parameters

string
Location ID supplied by the connected account; caller values are overwritten.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_GET_CATEGORIES_IDRetrieve a specific category by its ID Location PITs must be provisioned with the HighLevel permission: socialplanner/category.readonly.

Input Parameters

string
required
Category Id
string
Location ID supplied by the connected account; caller values are overwritten.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_GET_CATEGORIES_LOCATION_IDRetrieve all categories for a specific location with optional search and pagination Location PITs must be provisioned with the HighLevel permission: socialplanner/category.readonly.

Input Parameters

integer
Number of categories to skip
integer
Maximum categories to return
string
Opaque continuation cursor returned by the previous call.
string
Location ID supplied by the connected account; caller values are overwritten.
string
Search text string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Pagination offset — number of comments to skip (zero-based). Must be ≥ 0.
number
Pagination page size — number of comments to return. Must be between 1 and 100.
string
Search
string ("top" | "latest")
Sort by top comments or latest comments
string
End of the published-date window (ISO 8601). If provided, fromDate is also required.
string ("facebook" | "instagram" | "linkedin" | "community" | "tiktok" | "bluesky" | "youtube" | "threads")
required
Platform whose comments to list
string
Start of the published-date window (ISO 8601). If provided, toDate is also required, and fromDate must be ≤ toDate. Omit both to disable date filtering.
string
Parent ID — pass the Highlevel post ID (for replies under a specific post) or the Highlevel comment ID (for replies under a specific comment). Omit to list all top-level comments for the location filtered by originIds. Must be a valid 24-character Highlevel ID, not the native platform ID.
array
required
Origin IDs of connected accounts to filter by

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_GET_CSV_POSTGet details of a specific CSV import including its posts Location PITs must be provisioned with the HighLevel permission: socialplanner/csv.readonly.

Input Parameters

string
required
CSV Id
integer
Number of records to skip
integer
Maximum number of records to return
string
Opaque continuation cursor returned by the previous call.
string
Location ID supplied by the connected account; caller values are overwritten.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Search term to filter accounts/pages by name. Useful when the user has many pages to choose from.
string ("google" | "facebook" | "instagram" | "linkedin" | "tiktok" | "tiktok-business" | "youtube" | "pinterest" | "threads" | "bluesky")
required
Social media platform
string
required
The OAuth Account ID received from Step 1 (Start OAuth) via the window message event

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_GET_POSTGet post Location PITs must be provisioned with the HighLevel permission: socialplanner/post.readonly.

Input Parameters

string
required
Post Id
string
Location ID supplied by the connected account; caller values are overwritten.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of records to skip for pagination
string ("recent" | "all" | "scheduled" | "draft" | "failed" | "in_review" | "published" | "in_progress" | "pending" | "deleted")
type must be one of the following values: recent, all, scheduled, draft, failed, in_review, published, in_progress, pending and deleted
integer
Maximum number of records to return
string
Opaque continuation cursor returned by the previous call.
string
required
To Date
string
List of account Ids separated by comma as a string
string
required
From Date
string ("post" | "story" | "reel")
Post Type must be one of the following values: - post, story, reel
string
Location ID supplied by the connected account; caller values are overwritten.
boolean
Whether to include user data. Accepts a boolean and sends HighLevel the required lowercase boolean string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_GET_STATISTICSRetrieve analytics data for multiple social media accounts. Supports custom date ranges for both the current period and a comparison period. If no date ranges are provided, defaults to the last 7 days (excluding today) with comparison to the previous 7 days. Location PITs must be provisioned with the HighLevel permission: socialplanner/statistics.readonly.

Input Parameters

array
Array of social media platforms to filter analytics by. If not provided, all platforms will be included. NOTE: Linkedin (PAGE only) and Tiktok (BUSINESS only) are supported.
object
Comparison date range. Can only be provided when currentRange is also present. If omitted while currentRange is present, no comparison data is returned.
array
required
Array of connected social media account IDs to fetch analytics for. This can be found as ‘profileId’ in /accounts api.
object
Custom date range for the current analytics period. If omitted, defaults to the last 7 days (excluding today) with automatic comparison to the previous 7 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_GET_TAGS_BY_IDSRetrieve specific tags by their IDs Location PITs must be provisioned with the HighLevel permission: socialplanner/tag.readonly.

Input Parameters

array
required
Array of Tag Ids
string
Location ID supplied by the connected account; caller values are overwritten.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_GET_TAGS_LOCATION_IDRetrieve all tags for a specific location with optional search and pagination Location PITs must be provisioned with the HighLevel permission: socialplanner/tag.readonly.

Input Parameters

integer
Number of tags to skip
integer
Maximum tags to return
string
Opaque continuation cursor returned by the previous call.
string
Location ID supplied by the connected account; caller values are overwritten.
string
Search text string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_GET_UPLOAD_STATUSGet the status of all CSV imports for a location Location PITs must be provisioned with the HighLevel permission: socialplanner/csv.readonly.

Input Parameters

integer
Number of records to skip
integer
Maximum number of records to return
string
Opaque continuation cursor returned by the previous call.
string
required
User ID
string
Location ID supplied by the connected account; caller values are overwritten.
boolean
Include user data in response
boolean
Filter CSVs imported from template library

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Provider field itemId.
string
required
Provider field queueId.
string
Edit session ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Provider field queueId.
string
required
Edit session ID
boolean
If true, keeps the queue in DRAFT state after saving instead of automatically activating it. Only applicable when the queue is currently in DRAFT status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_SET_ACCOUNTSSet social media accounts for a CSV import to publish posts to Location PITs must be provisioned with the HighLevel permission: socialplanner/csv.write.

Input Parameters

string
required
User ID
string
Approver User Id
string
required
Name of file
string
required
File path
number
required
Entries Count. rowsCount must be between 1 and number of posts in CSV
array
required
Account Ids
string
Location ID supplied by the connected account; caller values are overwritten.
string ("basic" | "advance")
CSV file type - determines the format of the CSV file being imported

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
CSV Id
string
required
User ID
string
Location ID supplied by the connected account; caller values are overwritten.
boolean
required
Must be true because finalizing the CSV may schedule or publish imported posts to external social networks. This value is not sent to HighLevel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Provider field queueId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("active" | "paused" | "deleted")
Status of the Queue
boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Provider field queueId.
array
Publishing slots for the queue; each object specifies dayOfWeek and a time in HH:MM format.
string
Skip Date Time in ISO format
boolean
Enable posting future content. Automatically Queue any New Posts Created in this Category.
boolean
Skip legacy watermark cleanup when rescheduling posts
boolean
Prioritize new content over older content. When true, new items added via directToQueue will be placed at the top of the queue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Must be true to confirm this mutation and its external effects. Not sent to HighLevel.
string
required
Provider field itemId.
string
required
Provider field queueId.
string
New order value or position keyword (cyclic-aware). Accepts: - A number: explicit order value calculated by FE as midpoint between adjacent items - “top”: place at cyclic top (first to be scheduled next) - “bottom”: place at cyclic bottom (last to be scheduled) For positions between items, FE calculates: Math.floor((prevItem.order + nextItem.order) / 2)
string
Edit session ID
array
Platform-specific variations. Facebook posts without media need a variation with non-empty content.
string
Primary media URL (image)
object
Replacement post details. accountIds and userId are required; media defaults to an empty array.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SOCIAL_PLANNER_UPLOAD_CSVUpload a CSV file containing social media posts for bulk scheduling Location PITs must be provisioned with the HighLevel permission: socialplanner/csv.write.

Input Parameters

object
required
CSV file containing social media posts to upload for validation and staging.
string
Location ID supplied by the connected account; caller values are overwritten.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_CREATE_SHIPPING_CARRIERCreate a shipping carrier after explicit confirmation. Location PITs require store/shipping.write.

Input Parameters

string
required
Shipping carrier name.
array
Available carrier services.
string
required
Public rate callback URL.
boolean
required
Must be true to confirm this shipping configuration change.
boolean
Whether sellers may select multiple services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_CREATE_SHIPPING_RATECreate a shipping rate after explicit confirmation. For carrier rates, HighLevel overwrites the supplied rate name with the selected carrier’s name. Location PITs require store/shipping.write.

Input Parameters

string
required
Shipping rate name.
number
required
Rate amount or carrier handling fee.
string
required
Rate currency.
string
Delivery description.
number
required
Maximum condition value; use 0 for none.
number
required
Minimum condition value; use 0 for none.
string ("none" | "price" | "weight")
required
Pricing condition type.
boolean
required
Must be true to confirm this shipping configuration change.
boolean
Whether the rate is carrier-calculated.
string
required
Shipping zone ID.
string
Shipping carrier ID. Required when is_carrier_rate is true; omit for a flat rate.
number
Percentage carrier-rate fee.
array
Enabled carrier services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_CREATE_SHIPPING_ZONECreate a shipping zone after explicit confirmation. Location PITs require store/shipping.write.

Input Parameters

string
required
Shipping zone name.
array
required
Countries and states in the zone.
boolean
required
Must be true to confirm this shipping configuration change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_DELETE_SHIPPING_CARRIERDelete a shipping carrier after explicit confirmation. Location PITs require store/shipping.write.

Input Parameters

boolean
required
Must be true to confirm deleting this shipping carrier.
string
required
Shipping carrier ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_DELETE_SHIPPING_RATEDelete a shipping rate after explicit confirmation. Location PITs require store/shipping.write.

Input Parameters

boolean
required
Must be true to confirm deleting this shipping rate.
string
required
Shipping rate ID.
string
required
Shipping zone ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_DELETE_SHIPPING_ZONEDelete a shipping zone after explicit confirmation. Location PITs require store/shipping.write.

Input Parameters

boolean
required
Must be true to confirm deleting this shipping zone.
string
required
Shipping zone ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Source of the order quote.
object
Customer shipping address.
string
required
Customer country code.
array
required
Products or prices and quantities in the quote.
string
Coupon code.
boolean
Whether total_order_amount was already calculated.
boolean
Whether total order weight was already calculated and should not be recalculated.
number
Order amount used for rate matching. Required when amount_available is true.
number
Estimated total order weight in kilograms. Required when weight_available is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_GET_SHIPPING_CARRIERGet a shipping carrier by ID. Location PITs require store/shipping.readonly.

Input Parameters

string
required
Shipping carrier ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_GET_SHIPPING_RATEGet a shipping rate by ID. Location PITs require store/shipping.readonly.

Input Parameters

string
required
Shipping rate ID.
string
required
Shipping zone ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_GET_SHIPPING_ZONEGet a shipping zone by ID. Location PITs require store/shipping.readonly.

Input Parameters

string
required
Shipping zone ID.
boolean
Whether to include zone rates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_GET_STORE_SETTINGSGet store settings for the connected location. Location PITs require store/setting.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_LIST_SHIPPING_CARRIERSList shipping carriers. Location PITs require store/shipping.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_LIST_SHIPPING_RATESReturn one page of shipping rates. Location PITs require store/shipping.readonly.

Input Parameters

integer
Maximum rates to return.
integer
Offset returned by a previous call.
integer
Starting result offset.
string
required
Shipping zone ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_LIST_SHIPPING_ZONESReturn one page of shipping zones. Location PITs require store/shipping.readonly.

Input Parameters

integer
Maximum zones to return.
integer
Offset returned by a previous call.
integer
Starting result offset.
boolean
Whether to include each zone’s rates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_UPDATE_SHIPPING_CARRIERUpdate a shipping carrier after explicit confirmation. Location PITs require store/shipping.write.

Input Parameters

string
Shipping carrier name.
array
Available carrier services.
string
Public rate callback URL.
boolean
required
Must be true to confirm this shipping configuration change.
string
required
Shipping carrier ID.
boolean
Whether sellers may select multiple services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Shipping rate name.
number
Rate amount or carrier handling fee.
string
Rate currency.
string
Delivery description.
number
Maximum condition value; use 0 for none.
number
Minimum condition value; use 0 for none.
string ("none" | "price" | "weight")
Pricing condition type.
boolean
required
Must be true to confirm this shipping configuration change.
boolean
Whether the rate is carrier-calculated.
string
required
Shipping rate ID.
string
required
Shipping zone ID.
string
Shipping carrier ID.
number
Percentage carrier-rate fee.
array
Enabled carrier services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_STORE_UPDATE_SHIPPING_ZONEUpdate a shipping zone after explicit confirmation. Location PITs require store/shipping.write.

Input Parameters

string
Shipping zone name.
array
Countries and states in the zone.
boolean
required
Must be true to confirm this shipping configuration change.
string
required
Shipping zone ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SURVEYS_GET_SURVEYSReturn one offset-based page of surveys for the connected HighLevel location. Pass next_cursor back as skip to retrieve the next page. Location PITs must be provisioned with the HighLevel permission: surveys.readonly.

Input Parameters

integer
Number of matching surveys to skip.
integer
Maximum surveys to return (1-50).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_SURVEYS_GET_SURVEYS_SUBMISSIONSReturn one page of survey submissions for the connected HighLevel location. Pass next_cursor back as page to retrieve the next page. Location PITs must be provisioned with the HighLevel permission: surveys.readonly.

Input Parameters

string
Match a contact ID, name, email address, or phone number.
integer
One-based submission page number.
integer
Maximum submissions to return (1-100).
string
Inclusive end date in YYYY-MM-DD format.
string
Inclusive start date in YYYY-MM-DD format.
string
Return submissions for this survey only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_USERS_DELETE_USERQueue deletion of an existing HighLevel user. Location PITs must be provisioned with the HighLevel permission: users.write.

Input Parameters

string
required
Unique ID of the user to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_USERS_GET_USERRetrieve one HighLevel user by ID. Location PITs must be provisioned with the HighLevel permission: users.readonly.

Input Parameters

string
required
Unique ID of the user to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_USERS_SEARCH_USERSSearch users belonging to the connected HighLevel Location. Location PITs must be provisioned with the HighLevel permissions: locations.readonly, users.readonly.

Input Parameters

string
Comma-separated user IDs to include.
string ("admin" | "user")
User role to include.
integer
Number of matching users to skip.
string
Sort by the provider-supported dateAdded field.
string ("account" | "agency")
User account type to include.
integer
Maximum number of users to return on this page.
string
Full name, email address, or phone number to match.
string
Continuation offset returned by the previous page.
string ("asc" | "desc")
Sort direction, such as asc or desc.
boolean
Filter by whether two-way sync is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("admin" | "user")
User role.
string ("account" | "agency")
User account type.
string
Email address. HighLevel currently does not support changing it.
string
Phone number in E.164 format.
array
Scopes to enable for the user; an empty list disables all.
string
required
Unique ID of the user to update.
string
Last name of the user.
string
Company ID associated with the user.
string
First name of the user.
object
Feature permissions to assign to the user.
array
Location IDs the user may access.
object
Complete per-Location inbound Twilio number map; replaces the stored map.
string
URL of the user profile photo.
string ("en_US" | "es" | "fr_CA" | "fr_FR" | "nl" | "de" | "pt_PT" | "pt_BR" | "it" | "sv" | "da" | "fi" | "no")
User platform language preference.
array
Assigned-data-only scopes to enable; an empty list disables all.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Human-readable action name.
string
required
Identifier of the agent that will own the action.
string ("CALL_TRANSFER" | "DATA_EXTRACTION" | "IN_CALL_DATA_EXTRACTION" | "WORKFLOW_TRIGGER" | "SMS" | "APPOINTMENT_BOOKING" | "CUSTOM_ACTION" | "KNOWLEDGE_BASE")
required
Voice AI action type.
object
required
Keys by action_type. CALL_TRANSFER: triggerPrompt, transferToType ‘number’, transferToValue (+ country code, 11-16 chars), triggerMessage; hearWhisperMessage is an optional boolean. DATA_EXTRACTION/IN_CALL_DATA_EXTRACTION: contactFieldId, description, examples; overwriteExistingValue optional. WORKFLOW_TRIGGER: triggerPrompt, triggerMessage, workflowId for a published workflow. SMS: triggerPrompt, triggerMessage, messageBody. APPOINTMENT_BOOKING: calendarId, daysOfOfferingDates, slotsPerDay, hoursBetweenSlots. KNOWLEDGE_BASE: triggerPrompt, knowledgeBaseId. CUSTOM_ACTION: triggerPrompt, triggerMessage, apiDetails {url, method POST|GET, authenticationRequired/authenticationValue if needed, headers [{key,value}], parameters [{name, optional description, type, example}]}, selectedPaths (one or more for GET; [] for POST). For CUSTOM_ACTION, include selectedPaths for GET and omit non-empty headers and parameters: HighLevel may persist then report ‘Maximum call stack size exceeded’. After that error, call VOICE_AI_GET_AGENT with agent_id to verify persistence.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("en-US" | "pt-BR" | "es" | "fr" | "de" | "it" | "nl-NL" | "multi")
Language used for speech and understanding.
string
IANA timezone for scheduling, such as America/New_York.
string
Speech synthesis voice identifier.
string
required
Agent display name (1-40 characters).
object
Translation settings.
string
Instructions governing agent behavior.
string
Business represented by the agent.
string
Inbound phone number for the agent.
string
Number pool identifier.
string ("low" | "medium" | "high")
Tolerance for caller response delays.
string
Greeting spoken when calls are answered.
number
Maximum call duration in seconds (180-900).
array
Weekly intervals when the agent accepts calls.
array
Up to 10 workflows to trigger after calls.
boolean
Enable caller-idle reminders.
boolean
Disable use of this agent as a fallback.
object
Post-call notification recipients.
number
Seconds of silence before a reminder (1-20).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier of the agent that owns the action.
string
required
Unique identifier of the action to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the agent to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique Voice AI action identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique voice AI agent identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
First page number to fetch.
string
Optional agent search query.
string
Opaque cursor returned by a previous call.
integer
Agents per page (1-50).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_VOICE_AI_GET_CALL_LOGRetrieve one Voice AI call log owned by the connected HighLevel Location. Voice AI dashboard access may require product entitlement. Location PITs must be provisioned with the HighLevel permission: voice-ai-dashboard.readonly.

Input Parameters

string
required
Unique Voice AI call identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
First page number to fetch.
string ("ascend" | "descend")
Sort direction; used with sort_by.
string
Opaque continuation cursor returned by the previous call.
string ("duration" | "createdAt")
Field used to sort call logs.
string
Limit results to one agent.
number
Range end as a Unix timestamp.
string ("LIVE" | "TRIAL")
Call type filter.
integer
Call logs per page (1-50).
string
Comma-separated contact IDs.
number
Range start as a Unix timestamp.
string
One or more comma-separated Voice AI action types: CALL_TRANSFER, DATA_EXTRACTION, IN_CALL_DATA_EXTRACTION, WORKFLOW_TRIGGER, SMS, APPOINTMENT_BOOKING, CUSTOM_ACTION, or KNOWLEDGE_BASE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique agent identifier.
string ("en-US" | "pt-BR" | "es" | "fr" | "de" | "it" | "nl-NL" | "multi")
New language code.
string
New IANA timezone, such as America/New_York.
string
New speech synthesis voice identifier.
string
New agent name.
object
Replacement translation settings with enabled and language keys.
string
New behavior instructions.
string
New business name.
string
New inbound phone number.
string
New number pool identifier.
string ("low" | "medium" | "high")
New caller-response patience level.
string
New greeting.
number
New maximum duration in seconds.
array
Replacement working hours using provider camelCase keys.
array
Replacement post-call workflow IDs.
boolean
Enable or disable idle reminders.
boolean
Disable or enable backup use.
object
Replacement notification configuration using provider camelCase keys.
number
New idle reminder delay.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

string
required
Replacement human-readable action name.
string
required
Identifier of the agent that owns the action.
string
required
Unique action identifier.
string ("CALL_TRANSFER" | "DATA_EXTRACTION" | "IN_CALL_DATA_EXTRACTION" | "WORKFLOW_TRIGGER" | "SMS" | "APPOINTMENT_BOOKING" | "CUSTOM_ACTION" | "KNOWLEDGE_BASE")
required
Replacement Voice AI action type.
object
required
Complete replacement keys by action_type. CALL_TRANSFER: triggerPrompt, transferToType ‘number’, transferToValue (+ country code, 11-16 chars), triggerMessage; hearWhisperMessage is an optional boolean. DATA_EXTRACTION/IN_CALL_DATA_EXTRACTION: contactFieldId, description, examples; optional overwriteExistingValue. WORKFLOW_TRIGGER: triggerPrompt, triggerMessage, workflowId for a published workflow. SMS: triggerPrompt, triggerMessage, messageBody. APPOINTMENT_BOOKING: calendarId, daysOfOfferingDates, slotsPerDay, hoursBetweenSlots. KNOWLEDGE_BASE: triggerPrompt, knowledgeBaseId. CUSTOM_ACTION: triggerPrompt, triggerMessage, apiDetails {url, method POST|GET, authenticationRequired/authenticationValue if needed, headers [{key,value}], parameters [{name, optional description, type, example}]}, selectedPaths (one or more for GET; [] for POST). For CUSTOM_ACTION, include selectedPaths for GET and omit non-empty headers and parameters: HighLevel may persist then report ‘Maximum call stack size exceeded’. After that error, call VOICE_AI_GET_AGENT with agent_id to verify persistence.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_LOCATION_WORKFLOWS_GET_WORKFLOWReturn the workflows available to the connected HighLevel location. Location PITs must be provisioned with the HighLevel permission: workflows.readonly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not