Overview
A configuration is provided for establishing connections with the HighLevel service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
This guide demonstrates how to read data from the HighLevel service resource using the COZYROC REST Source component.
Step 1: Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open SSIS Toolbox and drag and drop COZYROC REST Source component.
Step 3: Double click on the REST Source component and select HighLevel connection from the combo. Then, select the desired HighLevel resource from the second dropdown.
Optionally, you can add extra parameters in the grid below if needed.
Step 4: Click on the Columns tab and select HighLevel resource columns you want to read.
Step 5: Click Preview to verify that all necessary resource columns are included.
Congratulations! You've successfully learned how to read data from the HighLevel service.
This guide explains how to write data to the HighLevel service resource using the COZYROC REST Destination component.
Step 1: Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2: Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3: Double click on the REST Destination component and select HighLevel connection from the combo. Also, select resource action and HighLevel resource you want to work on.
Step 4: Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the HighLevel resource.
Configuration
Base URL address: https://services.leadconnectorhq.com.
- OAuth
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- UserType: Required. Specify either Location OR Company as a user type.
- Identifier: Required. Specify the location or company identifier. Depends on what is set for parameter "UserType"
- scope: Required. Specify the desired scopes.
- Version: Required. Default is set to 2021-07-28.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}} -
Version:
{{=token.Version}}
Documentation: https://highlevel.stoplight.io/docs/integrations/a04191c0fabf9-authorization.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/businesses/.
The result is extracted from:{{=response.businesses}}.Documentation: https://highlevel.stoplight.io/docs/integrations/a8db8afcbe0a3-get-businesses-by-location.
- [Read Single] action
-
Endpoint URL address:
/businesses/{{=HighLevel.UI.BusinessEditor.getValue(parameters)}}.
The result is extracted from:{{=[response.business]}}.The action has the following user-defined parameters:
- businessId: Required. Specify business identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/7530dceccc379-get-business.
- [Create] action
-
Endpoint URL address:
/businesses/.Documentation: https://highlevel.stoplight.io/docs/integrations/7636876b20ac3-create-business.
- [Update] action
-
Endpoint URL address:
/businesses/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/b95210ff2a8d7-update-business.
- [Delete] action
-
Endpoint URL address:
/businesses/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/6f776fbd6dd1f-delete-business.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- phone
Template: ShortText.
Template: ShortText.
- website
Template: ShortText.
- address
Template: ShortText.
- city
Template: ShortText.
- description
Template: LongText.
- state
Template: ShortText.
- postalCode
Template: ShortText.
- country
Template: ShortText.
- createdBy
Template: BusinessUser.
- updatedBy
Template: BusinessUser.
- locationId
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/calendars/.
The result is extracted from:{{=response.calendars}}.Documentation: https://highlevel.stoplight.io/docs/integrations/e55dec1be7bee-get-calendars.
- [Read Single] action
-
Endpoint URL address:
/calendars/{{=parameters.calendarId}}.
The result is extracted from:{{=[response.calendar]}}.The action has the following user-defined parameters:
- calendarId: Required. Specify calendar identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/946f5e91e2532-get-calendar.
- [Create] action
-
Endpoint URL address:
/calendars/.Documentation: https://highlevel.stoplight.io/docs/integrations/db6affea7570b-create-calendar.
- [Update] action
-
Endpoint URL address:
/calendars/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/cf683b1696d31-update-calendar.
- [Delete] action
-
Endpoint URL address:
/calendars/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/57177f7074647-delete-calendar.
- id
A key field. Template: ShortText.
- notifications
Field components:
- An array.
- Contains the following components: type, shouldSendToContact, shouldSendToGuest, shouldSendToUser, shouldSendToSelectedUsers, selectedUsers.
- locationId
Template: ShortText.
- groupId
Template: ShortText.
- teamMembers
Field components:
- An array.
- Contains the following components: userId, priority, meetingLocationType, meetingLocation, isPrimary.
- eventType
Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- slug
Template: ShortText.
- widgetSlug
Template: ShortText.
- calendarType
Template: ShortText.
- widgetType
Template: ShortText.
- eventTitle
Template: ShortText.
- eventColor
Template: ShortText.
- meetingLocation
Template: ShortText.
- slotDuration
Data type: DT_I4
- preBufferUnit
Template: ShortText.
- slotInterval
Data type: DT_I4
- slotBuffer
Data type: DT_I4
- preBuffer
Data type: DT_I4
- appoinmentPerSlot
Data type: DT_I4
- appoinmentPerDay
Data type: DT_I4
- openHours
Field components:
- An array.
- Contains the following components: daysOfTheWeek, hours.
- enableRecurring
Data type: DT_BOOL
- recurring
Template: Recurring.
- formId
Template: ShortText.
- stickyContact
Data type: DT_BOOL
- isLivePaymentMode
Data type: DT_BOOL
- autoConfirm
Data type: DT_BOOL
- shouldSendAlertEmailsToAssignedMember
Data type: DT_BOOL
- alertEmail
Template: ShortText.
- googleInvitationEmails
Data type: DT_BOOL
- allowReschedule
Data type: DT_BOOL
- allowCancellation
Data type: DT_BOOL
- shouldAssignContactToTeamMember
Data type: DT_BOOL
- shouldSkipAssigningContactForExisting
Data type: DT_BOOL
- notes
Template: ShortText.
- pixelId
Template: ShortText.
- formSubmitType
Template: ShortText.
- formSubmitRedirectURL
Template: ShortText.
- formSubmitThanksMessage
Template: LongText.
- availabilityType
Data type: DT_I4
- availabilities
Field components:
- An array.
- Contains the following components: id, date, hours, deleted.
- guestType
Template: ShortText.
- consentLabel
Template: LongText.
- calendarCoverImage
Template: ShortText.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/calendars/groups.
The result is extracted from:{{=response.groups}}.Documentation: https://highlevel.stoplight.io/docs/integrations/89e47b6c05e67-get-groups.
- [Create] action
-
Endpoint URL address:
/calendars/groups.Documentation: https://highlevel.stoplight.io/docs/integrations/fefceb241288c-create-calendar-group.
- [Update] action
-
Endpoint URL address:
/calendars/groups/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/585481332e909-edit-group.
- [Delete] action
-
Endpoint URL address:
/calendars/groups/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/e8c53752f025d-delete-group.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- slug
Template: ShortText.
- isActive
Data type: DT_BOOL
- widgetType
Template: ShortText.
- dateAdded
Template: DateTime.
- dateUpdated
Template: DateTime.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: disable.
-
Uses template:
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/calendars/events.
The result is extracted from:{{=response.events}}.The action has the following user-defined parameters:
- startTime: Required. Specify the Start Time (in millis) (e.g) 1680373800000.
- endTime: Required. Specify the End Time (in millis) (e.g) 1680978599999.
Documentation: https://highlevel.stoplight.io/docs/integrations/a83f44a3112a4-get-calendar-events.
- [Delete] action
-
Endpoint URL address:
/calendars/events/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/96b85108e6d3b-delete-event.
The resource includes the fields from the Event template.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/calendars/events/appointments/{{parameters.eventId}}.
The result is extracted from:{{=[response.event]}}.The action has the following user-defined parameters:
- eventId: Required. Specify event identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/bc4114ff64e38-get-appointment.
- [Create] action
-
Endpoint URL address:
/calendars/events/appointments.Documentation: https://highlevel.stoplight.io/docs/integrations/a192f863cad27-create-appointment.
- [Update] action
-
Endpoint URL address:
/calendars/events/appointments/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/3a1380a3a9df8-edit-appointment.
The resource includes the fields from the Event template.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/calendars/blocked-slots.
The result is extracted from:{{=response.events}}.The action has the following user-defined parameters:
- startTime: Required. Specify the Start Time (in millis) (e.g) 1680373800000.
- endTime: Required. Specify the End Time (in millis) (e.g) 1680978599999.
Documentation: https://highlevel.stoplight.io/docs/integrations/e31320c70cfde-get-blocked-slots.
- [Create] action
-
Endpoint URL address:
/calendars/events/blocked-slots.Documentation: https://highlevel.stoplight.io/docs/integrations/5a52896a68879-create-block-slot.
- [Update] action
-
Endpoint URL address:
/calendars/events/blocked-slots/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/098186acbb8db-edit-block-slot.
The resource includes the fields from the Event template.
Based on resource template Skip.
- [Read] action
-
Endpoint URL address:
/calendars/resources/{{=parameters.resourceType}}.
The result is extracted from:{{=response}}.The action has the following user-defined parameters:
- resourceType: Required. Specify the calendar resource type.
Documentation: https://highlevel.stoplight.io/docs/integrations/e3a7d63a0134b-list-calendar-resources.
- [Read Single] action
-
Endpoint URL address:
/calendars/resources/{{=parameters.resourceType}}/{{=parameters.resourceId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- resourceType: Required. Specify the calendar resource type.
- resourceId: Required. Specify the calendar resource identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/146912d6a9c38-get-calendar-resource.
- [Create] action
-
Endpoint URL address:
/calendars/resources/{{=parameters.resourceType}}.The action has the following user-defined parameters:
- resourceType: Required. Specify the calendar resource type.
Documentation: https://highlevel.stoplight.io/docs/integrations/cad3af068e0e0-create-calendar-resource.
- [Update] action
-
Endpoint URL address:
/calendars/resources/{{=parameters.resourceType}}/{{=item._id}}.The action has the following user-defined parameters:
- resourceType: Required. Specify the calendar resource type.
Documentation: https://highlevel.stoplight.io/docs/integrations/20987bed71eb0-update-calendar-resource.
- [Delete] action
-
Endpoint URL address:
/calendars/resources/{{=parameters.resourceType}}/{{=item._id}}.The action has the following user-defined parameters:
- resourceType: Required. Specify the calendar resource type.
Documentation: https://highlevel.stoplight.io/docs/integrations/ca9afd52d4d0e-delete-calendar-resource.
- isActive
Data type: DT_BOOL
- deleted
Data type: DT_BOOL
- _id
A key field. Template: ShortText.
- name
Template: ShortText.
- description
Template: ShortText.
- capacity
Data type: DT_I4
- resourceType
Template: ShortText.
- locationId
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- __v
Data type: DT_I4
- calendarIds
Template: LongText. A composite field.
- quantity
Data type: DT_I4
- outOfService
Data type: DT_I4
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/campaigns/.
The result is extracted from:{{=response.campaigns}}.Documentation: https://highlevel.stoplight.io/docs/integrations/6e067fcb430b7-get-campaigns.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- status
Template: ShortText.
- locationId
Template: ShortText.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/companies/{{=parameters.companyId}}.
The result is extracted from:{{=[response.company]}}.The action has the following user-defined parameters:
- companyId: Required. Specify the company identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/cc7b8a7892119-get-company.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
Template: ShortText.
- logoUrl
Template: ShortText.
- phone
Template: ShortText.
- website
Template: ShortText.
- domain
Template: ShortText.
- spareDomain
Template: ShortText.
- privacyPolicy
Template: ShortText.
- termsConditions
Template: ShortText.
- theme
Template: ShortText.
- address
Template: ShortText.
- city
Template: ShortText.
- postalCode
Template: ShortText.
- country
Template: ShortText.
- state
Template: ShortText.
- timezone
Template: ShortText.
- relationshipNumber
Template: ShortText.
- faviconUrl
Template: ShortText.
- subdomain
Template: ShortText.
- plan
Data type: DT_I4
- currency
Template: ShortText.
- customerType
Template: ShortText.
- termsOfServiceVersion
Template: ShortText.
- termsOfServiceAcceptedBy
Template: ShortText.
- twilioTrialMode
Data type: DT_BOOL
- twilioFreeCredits
Data type: DT_I4
- termsOfServiceAcceptedDate
Template: Date.
- privacyPolicyVersion
Template: ShortText.
- privacyPolicyAcceptedBy
Template: ShortText.
- privacyPolicyAcceptedDate
Template: ShortText.
- affiliatePolicyVersion
Template: ShortText.
- affiliatePolicyAcceptedBy
Template: ShortText.
- affiliatePolicyAcceptedDate
Template: Date.
- isReselling
Data type: DT_BOOL
- onboardingInfo
Template: ShortText.
- stripeId
Template: ShortText.
- upgradeEnabledForClients
Data type: DT_BOOL
- cancelEnabledForClients
Data type: DT_BOOL
- autoSuspendEnabled
Data type: DT_BOOL
- saasSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: agencyDashboardVisibleTo, stripeConnectInitiatedBy.
-
Uses template:
- stripeActivePlan
Template: ShortText.
- stripeConnectId
Template: ShortText.
- enableDepreciatedFeatures
Data type: DT_BOOL
- premiumUpgraded
Data type: DT_BOOL
- status
Template: ShortText.
- locationCount
Data type: DT_I4
- disableEmailService
Data type: DT_BOOL
- billingInfo
Field components:
-
Uses template:
DateTime. - Contains the following components: first_trial_extension_processed_on, first_trial_extension_reason, second_trial_extension_processed_on, second_trial_extension_reason, pause_subscription_requested_on, pause_subscription_reason, pause_subscription_status, pause_subscription_req_processed_on, pause_subscription_req_by, end_trial_early, agency_pro_addon, coupons_added, reactivation_attempt, downgrade, first_payment_date, pause_subscription_info.
-
Uses template:
Based on resource template Next.
- [Read] action
-
Endpoint URL address:
/contacts/.
The result is extracted from:{{=response.contacts}}.Documentation: https://highlevel.stoplight.io/docs/integrations/ab55933a57f6f-get-contacts.
- [Read Single] action
-
Endpoint URL address:
/contacts/{{=parameters.contactId}}.
The result is extracted from:{{=[response.contact]}}.The action has the following user-defined parameters:
- contactId: Required. Specify contact identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/00c5ff21f0030-get-contact.
- [Read Business] action
-
Endpoint URL address:
/contacts/business/{{=HighLevel.UI.BusinessEditor.getValue(parameters)}}.
The result is extracted from:{{=response.contacts}}.
The result is paginated.The action has the following user-defined parameters:
- businessId: Required. Specify business identifier.
The following request parameters will be automatically processed:
-
skip:
{{=parameters.iterator}}
Documentation: https://highlevel.stoplight.io/docs/integrations/8efc6d5a99417-get-contacts-by-business-id.
- [Read duplicate] action
-
Endpoint URL address:
/contacts/search/duplicate.
The result is extracted from:{{=[response.contact]}}.
The result is paginated.The action has the following user-defined parameters:
- email: Specify email address to check duplicate contacts. [specify only if not specifying number parameter].
- number: Specify phone number to check duplicate contacts. [specify only if not specifying email parameter].
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/e30c4ea85d5f8-get-duplicate-contact.
- [Create] action
-
Endpoint URL address:
/contacts/.The following request parameters will be automatically processed:
-
application/json:
{{=_.omit(item, 'custom')}}
Documentation: https://highlevel.stoplight.io/docs/integrations/4c8362223c17b-create-contact.
-
application/json:
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=_.omit(item, 'custom')}}
Documentation: https://highlevel.stoplight.io/docs/integrations/9ce5a739d4fb9-update-contact.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/28ab84e9522b6-delete-contact.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- locationId
Template: ShortText. A read-only field.
- firstName
Template: ShortText.
- lastName
Template: ShortText.
Template: ShortText.
- emailLowerCase
Template: ShortText.
- timezone
Template: ShortText.
- companyName
Template: ShortText.
- phone
Template: ShortText.
- dnd
Data type: DT_BOOL
- dndSettings
Field components:
-
Uses template:
DndSetting. - Contains the following components: Call, Email, SMS, WhatsApp, GMB, FB.
-
Uses template:
- type
Template: ShortText.
- source
Template: ShortText.
- assignedTo
Template: ShortText.
- address1
Template: ShortText.
- city
Template: ShortText.
- state
Template: ShortText.
- country
Template: ShortText.
- postalCode
Template: ShortText.
- website
Template: ShortText.
- tags
Template: MultiSelect.
- dateOfBirth
Template: DateTime.
- dateAdded
Template: DateTime. A read-only field.
- dateUpdated
Template: DateTime. A read-only field.
- attachments
Template: MultiSelect.
- ssn
Template: ShortText.
- gender
Template: ShortText.
- keyword
Template: ShortText.
- firstNameLowerCase
Template: ShortText.
- fullNameLowerCase
Template: ShortText.
- lastNameLowerCase
Template: ShortText.
- lastActivity
Template: DateTime. A read-only field.
- businessId
Template: ShortText.
- attributionSource
Template: Attribution.
- lastAttributionSource
Template: Attribution.
- appointments
A read-only field. The value is gathered from
/contacts/{{=item.id}}/appointmentsaddress. The gathered value is processed with{{=response.events}}expression. Field components:- An array.
-
Uses template:
Event.
- tasks
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Contact | Task'].getData({ parameters: ['contactId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Task.
- notes
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Contact | Note'].getData({ parameters: ['contactId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Note.
- action
Field components:
-
Uses template:
NoBodyActionT. - Contains the following components: addToCampaign, removeFromCampaign, addToWorkflow, removeFromWorkflow, addFollowers, removeFollowers, addTags, removeTags.
-
Uses template:
- [External]
-
The external fields URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/customFields. The external fields list is extracted from:{{=HighLevel.getCustomFields(response.customFields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts/{{=parameters.contactId}}/tasks.
The result is extracted from:{{=response.tasks}}.The action has the following user-defined parameters:
- contactId: Required. Specify contact identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/db572d519b209-get-all-tasks.
- [Read Single] action
-
Endpoint URL address:
/contacts/{{=parameters.contactId}}/tasks/{{=parameters.taskId}}.
The result is extracted from:{{=[response.task]}}.The action has the following user-defined parameters:
- contactId: Required. Specify contact identifier.
- taskId: Required. Specify the task identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/c4d36fb259656-get-task.
- [Create] action
-
Endpoint URL address:
/contacts/{{=item.contactId}}/tasks.Documentation: https://highlevel.stoplight.io/docs/integrations/fa57d1470b87c-create-task.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.contactId}}/tasks/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/82e1223e90ec9-update-task.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.contactId}}/tasks/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/506ee1741ec7e-delete-task.
The resource includes the fields from the Task template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts/{{=parameters.contactId}}/notes.
The result is extracted from:{{=response.notes}}.The action has the following user-defined parameters:
- contactId: Required. Specify contact identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/73decb4b6d0c2-get-all-notes.
- [Read Single] action
-
Endpoint URL address:
/contacts/{{=parameters.contactId}}/notes/{{=parameters.noteId}}.
The result is extracted from:{{=[response.note]}}.The action has the following user-defined parameters:
- contactId: Required. Specify note identifier.
- noteId: Required. Specify the note identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/24cab1c2b3dfb-get-note.
- [Create] action
-
Endpoint URL address:
/contacts/{{=item.contactId}}/notes.Documentation: https://highlevel.stoplight.io/docs/integrations/5eab1684a9948-create-note.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.contactId}}/notes/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/71814e115658f-update-note.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.contactId}}/notes/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/d7e867be69e9f-delete-note.
The resource includes the fields from the Note template.
Based on resource template Next.
- [Read search] action
-
Endpoint URL address:
/conversations/search.
The result is extracted from:{{=response.conversations}}.
The result is paginated.The following request parameters will be automatically processed:
-
startAfterDate:
{{=parameters.iterator}}
Documentation: https://highlevel.stoplight.io/docs/integrations/d45ae3189eea8-search-conversations.
-
startAfterDate:
- [Read Single] action
-
Endpoint URL address:
/conversations/{{=parameters.conversationId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- conversationId: Required. Specify the conversation identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/d22efcfdb0c80-get-conversation.
- [Create] action
-
Endpoint URL address:
/conversations/.Documentation: https://highlevel.stoplight.io/docs/integrations/8d0b19e09176e-create-conversation.
- [Update] action
-
Endpoint URL address:
/conversations/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/f6c7d276afe8e-update-conversation.
- [Delete] action
-
Endpoint URL address:
/conversations/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/d6b698c33ff49-delete-conversation.
- id
A key field. Template: ShortText.
- contactId
Template: ShortText.
- locationId
Template: ShortText.
- deleted
Data type: DT_BOOL
- starred
Data type: DT_BOOL
- assignedTo
Template: ShortText.
- type
Template: ShortText.
- dateAdded
Template: UnixTime.
- dateUpdated
Template: UnixTime.
- lastMessageDate
Template: UnixTime.
- lastMessageType
Template: ShortText.
- lastMessageBody
Template: LongText.
- lastOutboundMessageAction
Template: ShortText.
- lastMessageDirection
Template: ShortText.
- inbox
Data type: DT_BOOL
- unreadCount
Data type: DT_I4
- lastManualMessageDate
Template: UnixTime.
- fullName
Template: ShortText.
- contactName
Template: ShortText.
Template: ShortText.
- tags
Template: MultiSelect.
- scoring
Template: MultiSelect.
- attributed
Data type: DT_BOOL
- sort
Template: MultiSelect.
- feedback
Template: LongText.
- companyName
Template: ShortText.
- phone
Template: ShortText.
- messages
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Conversation | Message'].getData({ batchSize: 100, parameters: ['conversationId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Message.
- attachments
The value is sent to
/conversations/messages/uploadaddress. Field components:-
Uses template:
LongText. - Contains the following components: attachmentUrls.
-
Uses template:
Based on resource template Next.
- [Read] action
-
Endpoint URL address:
/conversations/{{=parameters.conversationId}}/messages.
The result is extracted from:{{=response.messages.messages}}.
The result is paginated.The action has the following user-defined parameters:
- conversationId: Required. Specify the conversation identifier.
The following request parameters will be automatically processed:
-
lastMessageId:
{{=parameters.iterator}}
Documentation: https://highlevel.stoplight.io/docs/integrations/ab21134dad173-get-messages-by-conversation-id.
- [Read Single] action
-
Endpoint URL address:
/conversations/messages/{{=parameters.messageId}}.
The result is extracted from:{{=[response.message]}}.The action has the following user-defined parameters:
- messageId: Required. Specify the message identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/a503551cadede-get-message-by-message-id.
- [Update] action
-
Endpoint URL address:
/conversations/messages/{{=item.id}}/status.Documentation: https://highlevel.stoplight.io/docs/integrations/4518573836035-update-message-status.
The resource includes the fields from the Message template.
- action
Template: ShortText. Field components:
-
Uses template:
NoBodyActionT. - Contains the following components: addInboundMessage, sendNewMessage, cancelScheduledMessage.
-
Uses template:
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/courses/courses-exporter/public/import.Documentation: https://highlevel.stoplight.io/docs/integrations/7ca9bb420fe98-import-courses.
- locationId
Template: ShortText.
- userId
Template: ShortText.
- products
Field components:
- An array.
- Contains the following components: title, description, imageUrl, categories, instructorDetails.
Based on resource template Skip.
- [Read] action
-
Endpoint URL address:
/forms/.
The result is extracted from:{{=response.forms}}.Documentation: https://highlevel.stoplight.io/docs/integrations/49e29c1716c61-get-forms.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- locationId
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/forms/submissions.
The result is extracted from:{{=response.submissions}}.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}}
Documentation: https://highlevel.stoplight.io/docs/integrations/a6114bd7685d1-get-forms-submissions.
-
page:
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- contactId
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- formId
Template: ShortText.
Template: ShortText.
- others
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v }; })}}expression. Field components:- An array.
- Contains the following components: name, value.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/invoices/.
The result is extracted from:{{=response.invoices}}.The action has the following user-defined parameters:
- altType: Required.
- altId: Required.
The following request parameters will be automatically processed:
-
locationId:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/3cdfb8c2dd8d4-list-invoices.
- [Read Single] action
-
Endpoint URL address:
/invoices/{{=parameters.invoiceId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- altType: Required.
- altId: Required.
- invoiceId: Required. Specify the invoice identifier.
The following request parameters will be automatically processed:
-
locationId:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/09ff1bc76ef48-get-invoice.
- [Create] action
-
Endpoint URL address:
/invoices/.Documentation: https://highlevel.stoplight.io/docs/integrations/b2be804d8764c-create-invoice.
- [Update] action
-
Endpoint URL address:
/invoices/{{=item._id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/76f00a800fa6e-update-invoice.
- [Delete] action
-
Endpoint URL address:
/invoices/{{=item._id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/af9fb9b428e74-delete-invoice.
- _id
A key field. Template: ShortText.
- liveMode
Data type: DT_BOOL
- amountPaid
Data type: DT_R8
- altId
Template: ShortText. Before setting, the value is processed with
{{=value || connection.token.Identifier}}expression.- automaticTaxesCalculated
Data type: DT_BOOL
- altType
Template: ShortText.
- name
Template: ShortText.
- businessDetails
Template: BusinessDetail.
- invoiceNumber
Template: ShortText.
- currency
Template: ShortText.
- contactDetails
Template: ContactDetail.
- issueDate
Template: Date.
- dueDate
Template: Date.
- discount
Template: Discount.
- invoiceItems
Field components:
- An array.
-
Uses template:
Item.
- total
Data type: DT_R8
- invoiceTotal
Data type: DT_R8
- issueDate
Template: DateTime. A read-only field.
- invoiceNumber
Data type: DT_I4
- title
Template: ShortText.
- paymentSchedule
Template: ShortText.
- amountDue
Data type: DT_R8
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- sentAt
Template: DateTime.
- sentBy
Template: DateTime.
- updatedBy
Template: DateTime.
- termsNotes
Template: LongText.
- tipsReceived
Template: LongText. A composite field.
- syncDetails
Template: LongText. A composite field.
- sentFrom
Field components:
-
Uses template:
ShortText. - Contains the following components: fromName, fromEmail.
-
Uses template:
- sentTo
Field components:
-
Uses template:
LongText. - Contains the following components: email, emailCc, emailBcc, phoneNo.
-
Uses template:
- remindersConfiguration
Field components:
- Contains the following components: reminderSettings.
- totalSummary
Field components:
- Contains the following components: subTotal, discount.
- manualStatusTransitions
Field components:
- Contains the following components: sent.
- status
Template: ShortText.
- action
Template: ShortText. Field components:
- Contains the following components: recordPayment.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/invoices/template.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- altType: Required.
- altId: Required.
The following request parameters will be automatically processed:
-
locationId:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/2840a2faefb4f-list-templates.
- [Read Single] action
-
Endpoint URL address:
/invoices/template/{{=parameters.templateId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- altType: Required.
- altId: Required.
- templateId: Required. Specify the template identifier.
The following request parameters will be automatically processed:
-
locationId:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/3bacd8c4310d2-get-an-template.
- [Create] action
-
Endpoint URL address:
/invoices/template.Documentation: https://highlevel.stoplight.io/docs/integrations/7cc0fad9bc3c0-create-template.
- [Update] action
-
Endpoint URL address:
/invoices/template/{{=item._id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/7467126c48049-update-template.
- [Delete] action
-
Endpoint URL address:
/invoices/template/{{=item._id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/caaab6a02e9ad-delete-template.
- _id
A key field. Template: ShortText.
- altId
Template: ShortText. Before setting, the value is processed with
{{=value || connection.token.Identifier}}expression.- altType
Template: ShortText.
- name
Template: ShortText.
- businessDetails
Template: BusinessDetail.
- currency
Template: ShortText.
- discount
Template: Discount.
- termsNotes
Template: LongText.
- items
Field components:
- An array.
-
Uses template:
Item.
- total
Data type: DT_R8
- internal
Data type: DT_BOOL
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- automaticTaxesCalculated
Data type: DT_BOOL
- updatedBy
Template: ShortText.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/invoices/schedule.
The result is extracted from:{{=response.schedules}}.The action has the following user-defined parameters:
- altType: Required.
- altId: Required.
The following request parameters will be automatically processed:
-
locationId:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/7619335efb7fe-list-schedules.
- [Read Single] action
-
Endpoint URL address:
/invoices/schedule/{{=parameters.scheduleId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- altType: Required.
- altId: Required.
- scheduleId: Required. Specify the schedule identifier.
The following request parameters will be automatically processed:
-
locationId:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/ada2739ce720d-get-an-schedule.
- [Create] action
-
Endpoint URL address:
/invoices/schedule.Documentation: https://highlevel.stoplight.io/docs/integrations/aa147661cf568-create-invoice-schedule.
- [Update] action
-
Endpoint URL address:
/invoices/schedule/{{=item._id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/44c1dd3a54f54-update-schedule.
- [Delete] action
-
Endpoint URL address:
/invoices/schedule/{{=item._id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/69c0d2ec4f403-delete-schedule.
- _id
A key field. Template: ShortText.
- altId
Template: ShortText. Before setting, the value is processed with
{{=value || connection.token.Identifier}}expression.- status
Template: ShortText.
- liveMode
Data type: DT_BOOL
- altType
Template: ShortText.
- name
Template: ShortText.
- autoPayment
Field components:
- Contains the following components: enable, rrule.
- schedule
Field components:
-
Uses template:
ShortText. - Contains the following components: executeAt, rrule.
-
Uses template:
- invoices
Field components:
- An array.
- Contains the following components: _id, status, liveMode, amountPaid, altId, altType, name, businessDetails, invoiceNumber, currency, contactDetails, issueDate, dueDate, discount, invoiceItems, total, title, amountDue, createdAt, updatedAt.
- businessDetails
Template: BusinessDetail.
- currency
Template: ShortText.
- contactDetails
Template: ContactDetail.
- discount
Template: Discount.
- items
Field components:
- An array.
-
Uses template:
Item.
- total
Data type: DT_R8
- __v
Data type: DT_I4
- title
Template: ShortText.
- termsNotes
Template: ShortText.
- compiledTermsNotes
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- schedule
Field components:
- Contains the following components: rrule.
- updatedBy
Template: DateTime. A read-only field.
- sentTo
Field components:
-
Uses template:
LongText. - Contains the following components: email, emailCc, emailBcc, phoneNo.
-
Uses template:
- meta
Field components:
- Contains the following components: nextChildTask, parentTask.
- traceId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/links/.
The result is extracted from:{{=response.links}}.Documentation: https://highlevel.stoplight.io/docs/integrations/7b6e00ee0f653-get-links.
- [Create] action
-
Endpoint URL address:
/links/.Documentation: https://highlevel.stoplight.io/docs/integrations/30442546481af-create-link.
- [Update] action
-
Endpoint URL address:
/links/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/7fb0921457bdb-update-link.
- [Delete] action
-
Endpoint URL address:
/links/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/b38b571ee30bd-delete-link.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- fieldKey
Template: ShortText.
- redirectTo
Template: ShortText.
- locationId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}.
The result is extracted from:{{=[response.location]}}.Documentation: https://highlevel.stoplight.io/docs/integrations/d777490312af4-get-location.
- [Read search] action
-
Endpoint URL address:
/locations/search.
The result is extracted from:{{=response.locations}}.
The result is paginated.The following request parameters will be automatically processed:
-
skip:
{{=parameters.iterator}}
Documentation: https://highlevel.stoplight.io/docs/integrations/12f3fb56990d3-search-locations.
-
skip:
- [Create] action
-
Endpoint URL address:
/locations/.Documentation: https://highlevel.stoplight.io/docs/integrations/7cfc7963eda7c-create-location.
- [Update] action
-
Endpoint URL address:
/locations/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/cc00a2e3e4d70-put-location.
- [Delete] action
-
Endpoint URL address:
/locations/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/54dd4c281f465-delete-location.
- id
A key field. Template: ShortText.
- companyId
Template: ShortText.
- name
Template: ShortText.
- domain
Template: ShortText.
- address
Template: ShortText.
- city
Template: ShortText.
- state
Template: ShortText.
- logoUrl
Template: ShortText.
- country
Template: ShortText.
- postalCode
Template: ShortText.
- website
Template: ShortText.
- timezone
Template: ShortText.
- firstName
Template: ShortText.
- lastName
Template: ShortText.
Template: ShortText.
- phone
Template: ShortText.
- automaticMobileAppInvite
Data type: DT_BOOL
- dateAdded
Template: DateTime. A read-only field.
- business
Field components:
-
Uses template:
ShortText. - Contains the following components: city, state, country, postalCode, timezone, address, name.
-
Uses template:
- social
Field components:
-
Uses template:
ShortText. - Contains the following components: facebookUrl, googlePlus, linkedIn, foursquare, twitter, yelp, instagram, youtube, pinterest, blogRss, googlePlacesId.
-
Uses template:
- settings
Field components:
-
Uses template:
LongText. - Contains the following components: allowDuplicateContact, allowDuplicateOpportunity, allowFacebookNameMerge, disableContactTimezone, contactUniqueIdentifiers, crmSettings, saasSettings.
-
Uses template:
- reseller
Template: LongText. A composite field.
- tags
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Location | Tag'].getData({})}}expression. Field components:- An array.
-
Uses template:
Tag.
- customFields
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Location | Custom Field'].getData({})}}expression. Field components:- An array.
-
Uses template:
CustomField.
- customValues
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Location | Custom Value'].getData({})}}expression. Field components:- An array.
-
Uses template:
CustomValue.
- templates
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Location | Template'].getData({ batchSize: 100 })}}expression. Field components:- An array.
-
Uses template:
CustomValue.
- timezones
Template: LongText. A read-only field. A composite field. The value is gathered from
/locations/{{=HighLevel.getLocation(parameters)}}/timezonesaddress. The gathered value is processed with{{=response.timeZones}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/tags.
The result is extracted from:{{=response.tags}}.The following request parameters will be automatically processed:
-
locationId:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/00a65a984720b-get-location-tags.
-
locationId:
- [Read Single] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/tags/{{=HighLevel.UI.TagEditor.getValue(parameters)}}.
The result is extracted from:{{=[response.tag]}}.The action has the following user-defined parameters:
- tagId: Required. Specify tag identifier.
The following request parameters will be automatically processed:
-
locationId:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/2be6f9044b427-get-tag-by-id.
- [Create] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/tags.Documentation: https://highlevel.stoplight.io/docs/integrations/64433faeaa52e-create-tag.
- [Update] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/tags/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/809b211aaf37a-update-tag.
- [Delete] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/tags/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/8742f26722f45-delete-tag.
The resource includes the fields from the Tag template.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/customFields.
The result is extracted from:{{=response.customFields}}.Documentation: https://highlevel.stoplight.io/docs/integrations/791462a3367b9-get-custom-fields.
- [Read Single] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/customFields/{{=parameters.customFieldId}}.
The result is extracted from:{{=[response.customField]}}.The action has the following user-defined parameters:
- customFieldId: Required. Specify custom field identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/394d117ca4332-get-custom-field.
- [Create] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/customFields.Documentation: https://highlevel.stoplight.io/docs/integrations/7b2584aa2450c-create-custom-field.
- [Update] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/customFields/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/a96e05f71bdf4-update-custom-field.
- [Delete] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/customFields/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/ca83b24e1ca24-delete-custom-field.
The resource includes the fields from the CustomField template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/customValues.
The result is extracted from:{{=response.customValues}}.The following request parameters will be automatically processed:
-
locationId:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/d40742c5e3e7d-get-custom-values.
-
locationId:
- [Read Single] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/customValues/{{=parameters.customValueId}}.
The result is extracted from:{{=[response.customValue]}}.The action has the following user-defined parameters:
- customValueId: Required. Specify custom value identifier.
The following request parameters will be automatically processed:
-
locationId:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/1c982c0816621-get-custom-value.
- [Create] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/customValues.Documentation: https://highlevel.stoplight.io/docs/integrations/e0c3b7e6d196c-create-custom-value.
- [Update] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/customValues/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/c5c9b99b0e74f-update-custom-value.
- [Delete] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/customValues/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/40e00c29eb2da-delete-custom-value.
The resource includes the fields from the CustomValue template.
Based on resource template Skip.
- [Read] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/templates.
The result is extracted from:{{=response.templates}}.The following request parameters will be automatically processed:
-
locationId:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/2d66d23600a8b-get-all-or-email-sms-templates.
-
locationId:
- [Delete] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/templates/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/cdce8f8899efe-delete-an-email-sms-template.
The resource includes the fields from the Template template.
Based on resource template Skip.
- [Read] action
-
Endpoint URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/tasks/search.
The result is extracted from:{{=response.tasks}}.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=_.mapObject(parameters, function(item) { return JSON.parse(item); })}} -
skip:
{{=parameters.iterator || 0}} -
locationId:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/8d73480560089-task-search-filter.
-
application/json:
The resource includes the fields from the Task template.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/medias/files.
The result is extracted from:{{=response.files}}.The action has the following user-defined parameters:
- altType: Required. Specify the location or agency identifier.
- altId: Required. Specify the location or agency identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/0a4bf8cac58a9-get-list-of-files.
- [Create] action
-
Endpoint URL address:
/medias/upload-files.The action has the following user-defined parameters:
- hosted: Required. Specify the boolean value.
The following request parameters will be automatically processed:
-
file:
{{=item.content}} -
fileUrl:
{{=item.url}} -
hosted:
{{=parameters.hosted}}
Documentation: https://highlevel.stoplight.io/docs/integrations/f737851451054-upload-file-into-media-library.
- [Delete] action
-
Endpoint URL address:
/medias/{{=item.id}}.The action has the following user-defined parameters:
- altType: Required. Specify the location or agency identifier.
- altId: Required. Specify the location or agency identifier.
The following request parameters will be automatically processed:
-
altType:
{{=parameters.altType}} -
altId:
{{=parameters.altId}}
Documentation: https://highlevel.stoplight.io/docs/integrations/fb48a2a324010-delete-file-or-folder.
- id
A key field. Template: ShortText.
- altId
Template: ShortText.
- altType
Template: ShortText.
- name
Template: ShortText.
- parentId
Template: ShortText.
- url
Template: ShortText.
- path
Template: ShortText.
- content
Data type: DT_IMAGE
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/funnels/funnel/list.
The result is extracted from:{{=response.funnels}}.Documentation: https://highlevel.stoplight.io/docs/integrations/80d7ad39f1e90-fetch-list-of-funnels.
- _id
A key field. Template: ShortText.
- dateAdded
Template: DateTime. A read-only field.
- dateUpdated
Template: DateTime. A read-only field.
- deleted
Data type: DT_BOOL
- domainId
Template: ShortText.
- locationId
Template: ShortText.
- name
Template: ShortText.
- orderFormVersion
Data type: DT_I4
- originId
Template: ShortText.
- steps
Field components:
- An array.
- Contains the following components: id, name, originId, pages, products, sequence, type, url.
- type
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- faviconUrl
Template: ShortText.
- globalSectionVersion
Data type: DT_I4
- globalSectionsPath
Template: ShortText.
- globalSectionsUrl
Template: ShortText.
- isStoreActive
Data type: DT_BOOL
- trackingCodeBody
Template: ShortText.
- trackingCodeHead
Template: ShortText.
- url
Template: ShortText.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/funnels/lookup/redirect/list.
The result is extracted from:{{=response.data.data}}.Documentation: https://highlevel.stoplight.io/docs/integrations/a1a9c79cd27ed-fetch-list-of-redirects.
- [Create] action
-
Endpoint URL address:
/funnels/lookup/redirect.Documentation: https://highlevel.stoplight.io/docs/integrations/98aaa4819e58b-create-redirect.
- [Update] action
-
Endpoint URL address:
/funnels/lookup/redirect/{{=item.id}}.
The action uses PATCH method.Documentation: https://highlevel.stoplight.io/docs/integrations/42c343d756316-update-redirect-by-id.
- [Delete] action
-
Endpoint URL address:
/funnels/lookup/redirect/{{=item.id}}.
The action uses PATCH method.The following request parameters will be automatically processed:
-
locationId:
{{=HighLevel.getLocation(parameters)}}
Documentation: https://highlevel.stoplight.io/docs/integrations/55c4fc25361eb-delete-redirect-by-id.
-
locationId:
- id
A key field. Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- locationId
Template: ShortText.
- domain
Data type: DT_I4
- path
Template: ShortText.
- pathLowercase
Template: ShortText.
- type
Template: ShortText.
- target
Template: ShortText.
- action
Template: ShortText.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/funnels/page.
The result is extracted from:{{=response}}.The action has the following user-defined parameters:
- funnelId: Required. Specify the funnel identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/99a6409949f15-fetch-list-of-funnel-pages.
- _id
A key field. Template: ShortText.
- locationId
Template: ShortText.
- funnelId
Template: ShortText.
- name
Template: ShortText.
- stepId
Template: ShortText.
- deleted
Data type: DT_BOOL
- path
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template Next.
- [Read search] action
-
Endpoint URL address:
/opportunities/search.
The result is extracted from:{{=response.opportunities}}.The following request parameters will be automatically processed:
-
locationId:
{{=undefined}} -
location_id:
{{=HighLevel.getLocation(parameters)}}
Documentation: https://highlevel.stoplight.io/docs/integrations/a163e98c45b8d-search-opportunity.
-
locationId:
- [Read Single] action
-
Endpoint URL address:
/opportunities/{{=parameters.opportunityId}}.
The result is extracted from:{{=[response.opportunity]}}.The action has the following user-defined parameters:
- opportunityId: Required. Specify the opportunity identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/31798edaafcba-get-opportunity.
- [Create] action
-
Endpoint URL address:
/opportunities/.The following request parameters will be automatically processed:
-
application/json:
{{=_.omit(item, 'custom')}}
Documentation: https://highlevel.stoplight.io/docs/integrations/802093aa63900-create-opportunity.
-
application/json:
- [Update] action
-
Endpoint URL address:
/opportunities/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=_.omit(item, 'custom')}}
Documentation: https://highlevel.stoplight.io/docs/integrations/ca75b3ab9e828-update-opportunity.
-
application/json:
- [Upsert] action
-
Endpoint URL address:
/opportunities/upsert.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://highlevel.stoplight.io/docs/integrations/9df1c12e5da99-upsert-opportunity.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/opportunities/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/11568af679dff-delete-opportunity.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- monetaryValue
Data type: DT_I4
- pipelineId
Template: ShortText.
- pipelineStageId
Template: ShortText.
- pipelineStageUId
Template: ShortText.
- assignedTo
Template: ShortText.
- source
Template: ShortText.
- lastStatusChangeAt
Template: DateTime.
- lastStageChangeAt
Template: DateTime.
- lastActionDate
Template: ShortText.
- indexVersion
Data type: DT_I4
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- contactId
Template: ShortText.
- locationId
Template: ShortText.
- contact
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, companyName, email, phone, tags.
-
Uses template:
- calendarEvents
Template: LongText. A composite field.
- internalSource
Field components:
-
Uses template:
ShortText. - Contains the following components: apiVersion, channel, id, source, type.
-
Uses template:
- followers
Template: LongText. A composite field.
- sort
Template: LongText. A composite field.
- relations
Field components:
- An array.
- Contains the following components: associationId, relationId, primary, objectKey, recordId, fullName, contactName, companyName, email, tags.
- notes
Field components:
- An array.
- Contains the following components: body, companyId, contactId, createdBy, dateAdded, dateUpdated, deleted, lastUpdatedBy, locationId, userId, updatedAt, businessId.
- tasks
Field components:
- An array.
- Contains the following components: assignedTo, body, businessId, companyId, completed, contactId, createdBy, dateAdded, dateUpdated, deleted, dueDate, lastUpdatedBy, locationId, title, updatedAt.
- status
Template: ShortText.
- isAttribute
Data type: DT_BOOL
- monetaryValue
Data type: DT_R8
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: addFollowers, removeFollowers, updateStatus.
-
Uses template:
- [External]
-
The external fields URL address:
/locations/{{=HighLevel.getLocation(parameters)}}/customFields. The external fields list is extracted from:{{=HighLevel.getCustomFields(response.customFields)}}.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/opportunities/pipelines.
The result is extracted from:{{=response.pipelines}}.Documentation: https://highlevel.stoplight.io/docs/integrations/927589990bc39-get-pipelines.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- stages
Field components:
- An array.
- Contains the following components: id, name, position, showInFunnel, showInPieChart.
- showInFunnel
Data type: DT_BOOL
- showInPieChart
Data type: DT_BOOL
- locationId
Template: ShortText.
- dateAdded
Template: DateTime. A read-only field.
- dateUpdated
Template: DateTime. A read-only field.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/payments/integrations/provider/whitelabel.
The result is extracted from:{{=response.providers}}.The action has the following user-defined parameters:
- altType: Required. Specify the altType.
- altId: Required. Specify the altId.
Documentation: https://highlevel.stoplight.io/docs/integrations/cbdced5c59dfd-list-white-label-integration-providers.
- [Create] action
-
Endpoint URL address:
/payments/integrations/provider/whitelabel.Documentation: https://highlevel.stoplight.io/docs/integrations/38fc7b49d107d-create-white-label-integration-provider.
- _id
A key field. Template: ShortText.
- altId
Template: ShortText.
- altType
Template: ShortText.
- title
Template: ShortText.
- route
Template: ShortText.
- provider
Template: ShortText.
- uniqueName
Template: ShortText.
- description
Template: LongText.
- imageUrl
Template: LongText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/payments/orders.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- altType: Required. Specify the altType.
- altId: Required. Specify the altId.
Documentation: https://highlevel.stoplight.io/docs/integrations/378562f514a17-list-orders.
- [Read Single] action
-
Endpoint URL address:
/payments/orders/{{=parameters.orderId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- altType: Required. Specify the altType.
- altId: Required. Specify the altId.
- orderId: Required. Specify the order Identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/378562f514a17-list-orders.
- _id
A key field. Template: ShortText.
- altId
Template: ShortText.
- altType
Template: ShortText.
- contactId
Template: ShortText.
- contactName
Template: ShortText.
- contactEmail
Template: ShortText.
- currency
Template: ShortText.
- amount
Data type: DT_R8
- subtotal
Data type: DT_R8
- discount
Data type: DT_R8
- status
Template: ShortText.
- liveMode
Data type: DT_BOOL
- totalProducts
Data type: DT_I4
- sourceType
Template: ShortText.
- sourceName
Template: ShortText.
- sourceId
Template: ShortText.
- sourceMeta
Template: ShortText.
- couponCode
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- sourceSubType
Template: ShortText.
- fulfillmentStatus
Template: ShortText.
- onetimeProducts
Data type: DT_I4
- recurringProducts
Data type: DT_I4
- contactSnapshot
Template: ShortText.
- amountSummary
Template: Dictionary.
- source
Template: Dictionary.
- items
Template: ShortText.
- coupon
Template: ShortText.
- trackingId
Template: ShortText.
- fingerprint
Template: ShortText.
- meta
Template: ShortText.
- markAsTest
Template: ShortText.
- traceId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payments/orders/{{=parameters.orderId}}/fulfillments.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- altType: Required. Allowed value is location.
- altId: Required. Specify the location or agency identifier.
- orderId: Required. Specify the order Identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/670fe5beec7de-list-fulfillment.
- [Create] action
-
Endpoint URL address:
/payments/orders/{{=item._id}}/fulfillments.Documentation: https://highlevel.stoplight.io/docs/integrations/1e091099a92c6-create-order-fulfillment.
- _id
A key field. Template: ShortText.
- altId
Template: ShortText.
- altType
Template: ShortText.
- trackings
Field components:
- An array.
- Contains the following components: trackingNumber, shippingCarrier, trackingUrl.
- items
Field components:
- An array.
- Contains the following components: _id, name, product, price, qty.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/payments/transactions.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- altType: Required. Specify the altType.
- altId: Required. Specify the altId.
Documentation: https://highlevel.stoplight.io/docs/integrations/4d127e6508f0a-list-transactions.
- [Read Single] action
-
Endpoint URL address:
/payments/transactions/{{=parameters.transactionId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- altType: Required. Specify the altType.
- altId: Required. Specify the altId.
- transactionId: Required. Specify the transaction Identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/722e5769feada-get-transaction-by-id.
- _id
A key field. Template: ShortText.
- altId
Template: ShortText.
- altType
Template: ShortText.
- contactId
Template: ShortText.
- contactName
Template: ShortText.
- contactEmail
Template: ShortText.
- currency
Template: ShortText.
- amount
Data type: DT_R8
- status
Template: ShortText.
- liveMode
Data type: DT_BOOL
- entityType
Template: ShortText.
- entityId
Template: ShortText.
- entitySourceType
Template: ShortText.
- entitySourceSubType
Template: ShortText.
- entitySourceName
Template: ShortText.
- entitySourceId
Template: ShortText.
- entitySourceMeta
Template: ShortText.
- subscriptionId
Template: ShortText.
- chargeId
Template: ShortText.
- chargeSnapshot
Template: ShortText.
- paymentProviderType
Template: ShortText.
- paymentProviderConnectedAccount
Template: ShortText.
- ipAddress
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- amountRefunded
Data type: DT_R8
- paymentMethod
Template: ShortText.
- contactSnapshot
Template: ShortText.
- entitySource
Template: Dictionary.
- invoiceId
Template: ShortText.
- paymentProvider
Template: ShortText.
- meta
Template: ShortText.
- markAsTest
Data type: DT_BOOL
- isParent
Data type: DT_BOOL
- receiptId
Template: ShortText.
- qboSynced
Data type: DT_BOOL
- qboResponse
Template: ShortText.
- traceId
Template: ShortText.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/payments/subscriptions.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- altType: Required. Specify the altType.
- altId: Required. Specify the altId.
Documentation: https://highlevel.stoplight.io/docs/integrations/33c965c6cb9da-list-subscriptions.
- [Read Single] action
-
Endpoint URL address:
/payments/subscriptions/{{=parameters.subscriptionId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- altType: Required. Specify the altType. Allowed value is location.
- altId: Required. Specify the altId.
- subscriptionId: Required. Specify the subscription Identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/7be164894d54e-get-subscription-by-id.
- _id
A key field. Template: ShortText.
- altId
Template: ShortText.
- altType
Template: ShortText.
- contactId
Template: ShortText.
- contactName
Template: ShortText.
- contactEmail
Template: ShortText.
- currency
Template: ShortText.
- amount
Data type: DT_R8
- status
Template: ShortText.
- liveMode
Data type: DT_BOOL
- entityType
Template: ShortText.
- entityId
Template: ShortText.
- entitySourceType
Template: ShortText.
- entitySourceName
Template: ShortText.
- entitySourceId
Template: ShortText.
- entitySourceMeta
Template: ShortText.
- subscriptionId
Template: ShortText.
- subscriptionSnapshot
Template: ShortText.
- paymentProviderType
Template: ShortText.
- paymentProviderConnectedAccount
Template: ShortText.
- ipAddress
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- contactSnapshot
Template: ShortText.
- coupon
Template: ShortText.
- entitySource
Template: Dictionary.
- paymentProvider
Template: ShortText.
- meta
Template: ShortText.
- markAsTest
Template: ShortText.
- schedule
Template: Dictionary.
- autoPayment
Template: ShortText.
- recurringProduct
Template: ShortText.
- canceledAt
Template: ShortText.
- canceledBy
Template: ShortText.
- traceId
Template: ShortText.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/products/.
The result is extracted from:{{=response.products}}.Documentation: https://highlevel.stoplight.io/docs/integrations/7f6ce42d09400-list-products.
- [Read Single] action
-
Endpoint URL address:
/products/{{=HighLevel.UI.ProductEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- productId: Required. Specify the product Identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/272e8f008adb0-get-product-by-id.
- [Create] action
-
Endpoint URL address:
/products/.Documentation: https://highlevel.stoplight.io/docs/integrations/9eda2dc176c9c-create-product.
- [Update] action
-
Endpoint URL address:
/products/{{=item._id)).Documentation: https://highlevel.stoplight.io/docs/integrations/469d7a90e0d15-update-product-by-id.
- [Delete] action
-
Endpoint URL address:
/products/{{=item._id)).Documentation: https://highlevel.stoplight.io/docs/integrations/285e8c049b2e1-delete-product-by-id.
- _id
A key field. Template: ShortText.
- description
Template: LongText.
- variants
Field components:
- An array.
-
Uses template:
Variant.
- medias
Field components:
- An array.
-
Uses template:
Media.
- locationId
Template: ShortText.
- name
Template: ShortText.
- productType
Template: ShortText.
- availableInStore
Data type: DT_BOOL
- userId
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- statementDescriptor
Template: ShortText.
- image
Template: ShortText.
- prices
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Product | Price'].getData({ parameters: ['productId=' + item._id] })}}expression. Field components:- An array.
-
Uses template:
Price.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/products/{{=HighLevel.UI.ProductEditor.getValue(parameters)}}/price.
The result is extracted from:{{=response.prices}}.The action has the following user-defined parameters:
- productId: Required. Specify the product Identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/4f8b3c58c2e81-list-prices-for-a-product.
- [Read Single] action
-
Endpoint URL address:
/products/{{=HighLevel.UI.ProductEditor.getValue(parameters)}}/price/{{=parameters.priceId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- productId: Required. Specify the product Identifier.
- priceId: Required. Specify the price Identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/f902955da364a-get-price-by-id-for-a-product.
- [Create] action
-
Endpoint URL address:
/products/{{=HighLevel.UI.ProductEditor.getValue(parameters)}}/price.The action has the following user-defined parameters:
- productId: Required. Specify the product Identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/a47cd944aede9-create-price-for-a-product.
- [Update] action
-
Endpoint URL address:
/products/{{=HighLevel.UI.ProductEditor.getValue(parameters)}}/price/{{=item.id}}.The action has the following user-defined parameters:
- productId: Required. Specify the product Identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/7ffcf47b1687a-update-price-by-id-for-a-product.
- [Delete] action
-
Endpoint URL address:
/products/{{=HighLevel.UI.ProductEditor.getValue(parameters)}}/price/{{=item.id}}.The action has the following user-defined parameters:
- productId: Required. Specify the product Identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/6025f28b731c1-delete-price-by-id-for-a-product.
The resource includes the fields from the Price template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/snapshots/.
The result is extracted from:{{=response.snapshots}}.The action has the following user-defined parameters:
- companyId: Required.
Documentation: https://highlevel.stoplight.io/docs/integrations/b7ac59fac1e81-get-snapshots.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
Based on resource template Base.
- [Read between dates] action
-
Endpoint URL address:
/snapshots/snapshot-status/{{=parameters.snapshotId}}.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- companyId: Required.
- snapshotId: Required. Specify the snapshot identifier.
- from: Required. Specify the from date (e.g) 10-10-2022 12:00 AM.
- to: Required. Specify the to date (e.g) 12-18-2023 11:59 PM.
- lastDoc: Required. Specify Id for last document till what you want to skip.
Documentation: https://highlevel.stoplight.io/docs/integrations/3aafd3250cc4d-get-snapshot-push-between-dates.
- [Read last push] action
-
Endpoint URL address:
/snapshots/snapshot-status/{{=parameters.snapshotId}}/location/{{=parameters.locationId}}.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- companyId: Required.
- snapshotId: Required. Specify the snapshot identifier.
- from: Required. Specify the from date (e.g) 10-10-2022 12:00 AM.
- to: Required. Specify the to date (e.g) 12-18-2023 11:59 PM.
- lastDoc: Required. Specify Id for last document till what you want to skip.
Documentation: https://highlevel.stoplight.io/docs/integrations/6c45f1aad5098-get-last-snapshot-push.
- id
A key field. Template: ShortText.
- locationId
Template: ShortText.
- status
Template: ShortText.
- completed
Template: LongText. A composite field.
- pending
Template: LongText. A composite field.
- type
Template: ShortText.
- dateAdded
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/snapshots/share/link.The action has the following user-defined parameters:
- companyId: Required.
Documentation: https://highlevel.stoplight.io/docs/integrations/7cfd7fa37e660-create-snapshot-share-link.
- id
A key field. Template: ShortText.
- snapshot_id
Template: ShortText.
- share_type
Template: LongText.
- relationship_number
Template: LongText.
- share_location_id
Template: LongText.
Based on resource template Skip.
- [Read] action
-
Endpoint URL address:
/social-media-posting/{{=HighLevel.getLocation(parameters)}}/posts/list.
The result is extracted from:{{=response.posts}}.
The action uses POST method.The action has the following user-defined parameters:
- type: Required. Specify business identifier.
- fromDate: Required. Specify the fromDate (e.g) 2024-01-22T05:32:49.463Z.
- toDate: Required. Specify the toDate (e.g) 2024-03-22T05:32:49.463Z.
- includeUsers: Required. Specify the boolean value for parameter includeUsers.
The following request parameters will be automatically processed:
-
application/json:
{{=_.mapObject(parameters, function(item) { return JSON.parse(item); })}} -
skip:
{{=parameters.iterator || 0}}
Documentation: https://highlevel.stoplight.io/docs/integrations/940564cb61b7a-get-posts.
- [Read Single] action
-
Endpoint URL address:
/social-media-posting/{{=HighLevel.getLocation(parameters)}}/posts/{{=parameters.postId}}.
The result is extracted from:{{=[response.results.post]}}.The action has the following user-defined parameters:
- postId: Required. Specify the post identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/0c8f95f0475b6-get-post.
- [Create] action
-
Endpoint URL address:
/social-media-posting/{{=HighLevel.getLocation(parameters)}}/posts.Documentation: https://highlevel.stoplight.io/docs/integrations/a5f94391c5769-create-post.
- [Update] action
-
Endpoint URL address:
/social-media-posting/{{=HighLevel.getLocation(parameters)}}/posts/{{=item._id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/e19ddd9d990f2-edit-post.
- [Delete] action
-
Endpoint URL address:
/social-media-posting/{{=HighLevel.getLocation(parameters)}}/posts/{{=item._id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/e1a230b5e2119-delete-post.
- _id
A key field. Template: ShortText.
- source
Template: ShortText.
- locationId
Template: ShortText.
- platform
Template: ShortText.
- displayDate
Template: DateTime.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- accountId
Template: ShortText.
- error
Template: ShortText.
- postId
Template: ShortText.
- publishedAt
Template: DateTime. A read-only field.
- accountIds
Template: MultiSelect.
- summary
Template: LongText.
- media
Field components:
- An array.
- Contains the following components: url, caption, type, thumbnail, defaultThumb, id.
- status
Template: ShortText.
- createdBy
Template: ShortText.
- type
Template: ShortText.
- tags
Template: MultiSelect.
- ogTagsDetails
Field components:
-
Uses template:
ShortText. - Contains the following components: metaImage, metaLink.
-
Uses template:
- postApprovalDetails
Field components:
-
Uses template:
ShortText. - Contains the following components: approver, requesterNote, approverNote, approvalStatus, approverUser.
-
Uses template:
- tiktokPostDetails
Field components:
-
Uses template:
ShortText. - Contains the following components: privacyLevel, promoteOtherBrand, enableComment, enableDuet, enableStitch, videoDisclosure, promoteYourBrand.
-
Uses template:
- gmbPostDetails
Field components:
-
Uses template:
ShortText. - Contains the following components: gmbEventType, title, offerTitle, startDate, endDate, termsConditions, url, couponCode, redeemOnlineUrl, actionType.
-
Uses template:
- user
Template: PostUser.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/social-media-posting/{{=HighLevel.getLocation(parameters)}}/accounts.
The result is extracted from:{{=response.results.accounts}}.Documentation: https://highlevel.stoplight.io/docs/integrations/68caa66190323-get-accounts.
- [Delete] action
-
Endpoint URL address:
/social-media-posting/{{=HighLevel.getLocation(parameters)}}/accounts/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/0742a20a8ff2a-delete-account.
- id
A key field. Template: ShortText.
- oauthId
Template: ShortText.
- profileId
Template: ShortText.
- name
Template: ShortText.
- platform
Template: ShortText.
- type
Template: ShortText.
- expire
Template: DateTime.
- isExpired
Data type: DT_BOOL
- meta
Field components:
- Contains the following components: hasGoogleUpdated, canDelete.
Based on resource template Skip.
- [Read] action
-
Endpoint URL address:
/social-media-posting/{{=HighLevel.getLocation(parameters)}}/categories.
The result is extracted from:{{=response.results.categories}}.Documentation: https://highlevel.stoplight.io/docs/integrations/4d10864389022-get-categories-by-location-id.
- [Read Single] action
-
Endpoint URL address:
/social-media-posting/{{=HighLevel.getLocation(parameters)}}/categories/{{=parameters.categoryId}}.
The result is extracted from:{{=[response.results.category]}}.The action has the following user-defined parameters:
- categoryId: Required. Specify the category identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/01e8ae547831a-get-categories-by-id.
- name
Template: ShortText.
- primaryColor
Template: ShortText.
- secondaryColor
Template: ShortText.
- locationId
Template: ShortText.
- _id
A key field. Template: ShortText.
- createdBy
Template: ShortText.
- deleted
Data type: DT_BOOL
- message
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template Skip.
- [Read] action
-
Endpoint URL address:
/social-media-posting/{{=HighLevel.getLocation(parameters)}}/tags.
The result is extracted from:{{=response.results.tags}}.Documentation: https://highlevel.stoplight.io/docs/integrations/fb19549055c5d-get-tags-by-location-id.
- [Read Single] action
-
Endpoint URL address:
/social-media-posting/{{=HighLevel.getLocation(parameters)}}/tags/details.
The result is extracted from:{{=response.results.tags}}.
The action uses POST method.The action has the following user-defined parameters:
- tagIds: Required. Specify the arary of strings (e.g) ["tagId1","tagId2"].
The following request parameters will be automatically processed:
-
application/json:
{{=_.mapObject(parameters, function(item) { return JSON.parse(item); })}}
Documentation: https://highlevel.stoplight.io/docs/integrations/4f45cd5c05cc2-get-tags-by-ids.
- _id
A key field. Template: ShortText.
- tag
Template: ShortText.
- locationId
Template: ShortText.
- createdBy
Template: ShortText.
- deleted
Data type: DT_BOOL
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template Skip.
- [Read] action
-
Endpoint URL address:
/surveys/.
The result is extracted from:{{=response.surveys}}.Documentation: https://highlevel.stoplight.io/docs/integrations/1e9fdbe3f2013-get-surveys.
- name
Template: ShortText.
- locationId
Template: ShortText.
- id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys/submissions.
The result is extracted from:{{=response.submissions}}.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}}
Documentation: https://highlevel.stoplight.io/docs/integrations/1e9fdbe3f2013-get-surveys.
-
page:
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- contactId
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- surveyId
Template: ShortText.
- others
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v }; })}}expression. Field components:- An array.
- Contains the following components: name, value.
Based on resource template Base.
- [Read search] action
-
Endpoint URL address:
/users/search.
The result is extracted from:{{=response.users}}.
The result is paginated.The action has the following user-defined parameters:
- companyId: Required.
The following request parameters will be automatically processed:
-
skip:
{{=parameters.iterator}} -
locationId:
{{=undefined}}
Documentation: https://highlevel.stoplight.io/docs/integrations/6fac93869cd3f-search-users.
- [Read location] action
-
Endpoint URL address:
/users/.
The result is extracted from:{{=response.users}}.Documentation: https://highlevel.stoplight.io/docs/integrations/2b1f72be935aa-get-user-by-location.
- [Read Single] action
-
Endpoint URL address:
/users/{{=parameters.userId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- userId: Required. Specify the user identifier.
Documentation: https://highlevel.stoplight.io/docs/integrations/a815845536249-get-user.
- [Create] action
-
Endpoint URL address:
/users/.Documentation: https://highlevel.stoplight.io/docs/integrations/cf3f982337757-create-user.
- [Update] action
-
Endpoint URL address:
/users/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/52e75431abf04-update-user.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.id}}.Documentation: https://highlevel.stoplight.io/docs/integrations/c0ec81b013379-delete-user.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- firstName
Template: ShortText.
- lastName
Template: ShortText.
Template: ShortText.
- password
Template: ShortText.
- phone
Template: ShortText.
- extension
Template: ShortText.
- type
Template: ShortText.
- role
Template: ShortText.
- locationIds
Template: LongText. A composite field.
- profilePhoto
Template: ShortText.
- scopes
Template: LongText. A composite field.
- scopesAssignedToOnly
Template: LongText. A composite field.
- freshdeskContactId
Template: ShortText.
- deleted
Data type: DT_BOOL
- permissions
Field components:
- Contains the following components: campaignsEnabled, campaignsReadOnly, contactsEnabled, workflowsEnabled, workflowsReadOnly, triggersEnabled, funnelsEnabled, websitesEnabled, opportunitiesEnabled, dashboardStatsEnabled, bulkRequestsEnabled, appointmentsEnabled, reviewsEnabled, onlineListingsEnabled, phoneCallEnabled, conversationsEnabled, assignedDataOnly, adwordsReportingEnabled, membershipEnabled, facebookAdsReportingEnabled, attributionsReportingEnabled, settingsEnabled, tagsEnabled, leadValueEnabled, marketingEnabled, agentReportingEnabled, botService, socialPlanner, bloggingEnabled, invoiceEnabled, affiliateManagerEnabled, contentAiEnabled, refundsEnabled, recordPaymentEnabled, cancelSubscriptionEnabled, paymentsEnabled, communitiesEnabled, exportPaymentsEnabled.
- roles
Field components:
-
Uses template:
ShortText. - Contains the following components: type, role, locationIds.
-
Uses template:
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: restoreUser.
-
Uses template:
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/workflows/.
The result is extracted from:{{=response.workflows}}.Documentation: https://highlevel.stoplight.io/docs/integrations/070d2f9be5549-get-workflow.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- status
Template: ShortText.
- version
Data type: DT_I4
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- locationId
Template: ShortText.
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
locationId:
{{=HighLevel.getLocation(parameters)}}
-
_includeUserParameters:
- [Read Single] action
-
The result is paginated.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
locationId:
{{=HighLevel.getLocation(parameters)}} -
limit:
{{=undefined}} -
offset:
{{=undefined}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template NoPagination.
- [Read] action
-
The following request parameters will be automatically processed:
-
limit:
{{=parameters.batchSize}}
-
limit:
Based on resource template Base.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
startAfter:
{{=new Uri(parameters.iterator).getQueryParamValue('startAfter')}} -
startAfterId:
{{=new Uri(parameters.iterator).getQueryParamValue('startAfterId')}}
-
startAfter:
Based on resource template Base.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
skip:
{{=parameters.iterator}}
-
skip:
Based on resource template Base.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator || '0'}}
-
offset:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- MultiSelect
Template: ShortText. A composite field. The gathered value is processed with
{{=HighLevel.getMultiSelect(item, field)}}expression.- UnixTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=value && new Date(parseFloat(value)).toUTCString()}}expression. Before setting, the value is processed with{{=value && new Date(value).valueOf()}}expression.- Decimal
Data type: DT_R8
- Number
Data type: DT_R8
- BusinessUser
Field components:
-
Uses template:
ShortText. - Contains the following components: source, channel, sourceId, createdAt.
-
Uses template:
- OpportunityUser
Field components:
-
Uses template:
ShortText. - Contains the following components: channel, source, timestamp, userId.
-
Uses template:
- Hour
Field components:
- Contains the following components: openHour, openMinute, closeHour, closeMinute.
- Event
Field components:
-
Uses template:
ShortText. - Contains the following components: id, address, title, calendarId, locationId, contactId, groupId, appointmentStatus, assignedUserId, users, notes, startTime, endTime, dateAdded, dateUpdated.
-
Uses template:
- DndSetting
Field components:
-
Uses template:
ShortText. - Contains the following components: status, message, code.
-
Uses template:
- Attribution
Field components:
-
Uses template:
ShortText. - Contains the following components: url, campaign, utmSource, utmMedium, utmContent, referrer, campaignId, fbclid, gclid, msclikid, dclid, fbc, fbp, fbEventId, userAgent, ip, medium, mediumId.
-
Uses template:
- PostMaterial
Field components:
-
Uses template:
ShortText. - Contains the following components: title, type, url.
-
Uses template:
- Post
Field components:
-
Uses template:
ShortText. - Contains the following components: title, visibility, thumbnailUrl, contentType, description, bucketVideoUrl, postMaterials.
-
Uses template:
- Category
Field components:
-
Uses template:
ShortText. - Contains the following components: title, visibility, thumbnailUrl, posts.
-
Uses template:
- Address
Field components:
-
Uses template:
ShortText. - Contains the following components: countryCode, addressLine1, addressLine2, city, state, postalCode.
-
Uses template:
- Item
Field components:
-
Uses template:
LongText. - Contains the following components: taxes, _id, productId, priceId, currency, name, qty, amount.
-
Uses template:
- BusinessDetail
Field components:
-
Uses template:
ShortText. - Contains the following components: name, address, phoneNo, website, logoUrl, customValues.
-
Uses template:
- Discount
Field components:
-
Uses template:
ShortText. - Contains the following components: type, value.
-
Uses template:
- Task
Field components:
-
Uses template:
ShortText. - Contains the following components: id, _id, title, body, assignedTo, contactId, dueDate, completed.
-
Uses template:
- Note
Field components:
-
Uses template:
ShortText. - Contains the following components: id, body, userId, businessId, contactId, dateAdded.
-
Uses template:
- Message
Field components:
-
Uses template:
ShortText. - Contains the following components: id, type, locationId, contactId, conversationId, recipients, emailMessageId, dateAdded, body, direction, status, source, contentType, messageType, attachments, error, meta.
-
Uses template:
- AdditionalEmail
Field components:
- An array.
- ContactDetail
Field components:
-
Uses template:
ShortText. - Contains the following components: id, phoneNo, email, customFields, name, address, additionalEmails, companyName.
-
Uses template:
- Tag
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, locationId.
-
Uses template:
- CustomField
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, fieldKey, placeholder, dataType, position, picklistOptions, picklistImageOptions, isAllowedCustomOption, isMultiFileAllowed, maxFileLimit, locationId, model.
-
Uses template:
- CustomValue
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, fieldKey, value, locationId.
-
Uses template:
- Template
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, type, template, dateAdded, locationId, urlAttachments.
-
Uses template:
- Option
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- Variant
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, options.
-
Uses template:
- Media
Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, url, type, isFeatured.
-
Uses template:
- Recurring
Field components:
-
Uses template:
ShortText. - Contains the following components: interval, intervalCount.
-
Uses template:
- MembershipOffer
Field components:
-
Uses template:
ShortText. - Contains the following components: label, value, _id.
-
Uses template:
- Price
Field components:
-
Uses template:
ShortText. - Contains the following components: _id, membershipOffers, variantOptionIds, locationId, product, userId, name, type, currency, amount, recurring, createdAt, updatedAt, compareAtPrice, trackInventory, availableQuantity, allowOutOfStockPurchases.
-
Uses template:
- Dictionary
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v }; })}}expression. Field components:- An array.
- Contains the following components: name, value.
- StartEndDate
Field components:
- Contains the following components: year, month, day.
- StartEndTime
Field components:
- Contains the following components: hours, minutes, seconds.
- PostUser
Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, firstName, lastName, profilePhoto, phone, email.
-
Uses template:
- ActionT
- NoBodyActionT
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.