Home Action Reference LeadConnector (GoHighLevel) Actions Reference

LeadConnector (GoHighLevel) Actions Reference

Last updated on Jun 03, 2026

LeadConnector (GoHighLevel) Actions Reference

This article covers all 41 LeadConnector actions available in TexAu. Use these actions to manage contacts, opportunities, businesses, calendars, conversations, tags, workflows, and locations in your GoHighLevel account.

Before you begin

  • TexAu account on any paid plan
  • LeadConnector (GoHighLevel) account with API access
  • API key added at Settings > Integrations

Contact Management

Create Contact

Creates a new contact record in your GoHighLevel CRM.

Inputs:

  • Location ID (Required): Location to create the contact in
  • First Name (Required): First name of the contact
  • Last Name: Last name of the contact
  • Email: Email address
  • Phone: Phone number
  • Company Name: Associated company
  • Contact Type: Lead or Customer
  • Address / City / State / Postal Code / Country: Address fields
  • Website URL: Contact's website
  • Timezone: Select from list
  • Date of Birth: Format: YYYY-MM-DD
  • Gender: Gender of the contact
  • Source: Acquisition source label
  • Tag: Single tag to apply
  • Global DND: Do Not Disturb flag
  • DND Channel Settings: Per-channel DND (Call, Email, SMS, WhatsApp, GMB, FB)

Get Contact

Returns full details for one contact by ID.

Inputs:

  • Contact ID (Required): ID of the contact to retrieve

Outputs

Returns all fields listed in Create Contact outputs, plus email validation status, additional emails, additional phones, business ID, assigned user, and session activity timestamps.

Use case: Pull a contact's current tags and DND status before deciding whether to include them in an outreach campaign.

Search Contacts

Search and filter contacts with advanced criteria, sorting, and pagination.

Inputs:

  • Location ID (Required): Location to search within
  • Search Query: General keyword search (max 75 characters)
  • Limit: Results per page (default: 25)
  • Filter Field: Field to filter on (e.g., email, phone, company_name, date_added)
  • Filter Operator: eq, not_eq, contains, not_contains, exists, not_exists, range
  • Filter Value: Value to match
  • Sort Field / Direction: Sort by date_added, date_updated, first_name, last_name, email

Outputs

Returns contact records with all standard fields, plus total count for pagination.

Use case: Find all contacts tagged "MQL" in a location and export them for enrichment in a multi-step workflow.

Update Contact

Update an existing contact's details.

Inputs:

  • Contact ID (Required): ID of the contact to update
  • First Name / Last Name / Email / Phone: Fields to update
  • Company Name / Address / City / State / Country: Location fields
  • Website URL / Timezone / Source / Tag: Additional fields
  • DND Settings: Per-channel DND controls

Outputs

Returns the updated contact record with all standard fields.

Use case: After enriching a contact's company data, write the company name and website back to their GoHighLevel record.

Upsert Contact

Creates a new contact or updates an existing one based on the location's duplicate contact settings.

Inputs:

  • Create New If Duplicate Allowed: If true, creates a new record even when a duplicate exists

Outputs

Returns all Create Contact outputs, plus Is New Contact (boolean indicating whether a new record was created).

Use case: Import a CSV of leads and let the upsert logic handle deduplication automatically based on email or phone.

Delete Contact

Permanently delete a contact by ID.

Inputs:

  • Contact ID (Required): ID of the contact to delete

Opportunity / Deal Management

Create Opportunity

Create a new opportunity in a specific pipeline.

Inputs:

  • Location ID (Required): Location for the opportunity
  • Contact ID (Required): Contact to associate
  • Pipeline ID (Required): Target pipeline
  • Opportunity Name (Required): Display name
  • Status (Required): open, won, lost, or abandoned
  • Pipeline Stage ID: Specific stage within the pipeline
  • Monetary Value: Deal value

Get Opportunity

Retrieve full details of one opportunity by ID.

Inputs:

  • Opportunity ID (Required): ID of the opportunity

Outputs

Returns all Create Opportunity outputs, plus source, last action date, notes, tasks, calendar events, lost reason ID, and follower IDs.

Use case: Check an opportunity's current stage and monetary value before triggering a conditional follow-up sequence.

Search Opportunities

Search and filter opportunities with sorting and pagination.

Inputs:

  • Location ID (Required): Location to search
  • Search Query: Keyword search (max 75 characters)
  • Limit: Results per page (default: 20)
  • Filter Field: Filter by status, pipeline_id, monetary_value, contact_name, email, and more
  • Filter Operator: eq, not_eq, contains, range, exists
  • Filter Value: Value to match
  • Sort Field / Direction: Sort by date_added, monetary_value, name, or status change dates

Outputs

Returns opportunity records with contact details, notes, tasks, and calendar events. Includes total count.

Use case: Pull all open opportunities over $10,000 to build a weekly forecast report.

Update Opportunity

Update an existing opportunity's fields.

Inputs:

  • Opportunity ID (Required): ID of the opportunity
  • Opportunity Name / Pipeline ID / Pipeline Stage ID / Status / Monetary Value: Fields to update

Outputs

Returns the full updated opportunity record with contact details, notes, tasks, and timestamps.

Use case: Move an opportunity to the next pipeline stage after a contact completes a qualifying action.

Update Opportunity Status

Change only the status of an opportunity (open, won, lost, abandoned).

Inputs:

  • Opportunity ID (Required): ID of the opportunity
  • Status (Required): New status value
  • Lost Reason ID: Required only when status is "lost"

Upsert Opportunity

Create a new opportunity or update an existing one.

Inputs:

  • Pipeline ID (Required): Target pipeline
  • Location ID (Required): Location for the opportunity
  • Followers Action Type (Required): "add" or "remove"
  • Remove All Followers (Required): Boolean flag
  • Follower (Contact ID) (Required): Follower contact IDs
  • Opportunity ID: Provide to update; leave blank to create
  • Name / Pipeline Stage ID / Status / Monetary Value / Lost Reason ID: Additional fields

Outputs

Returns the opportunity record plus Is New Opportunity (boolean).

Use case: Sync opportunity data from an external CRM and let upsert handle create-vs-update logic.

Delete Opportunity

Delete an opportunity by ID.

Inputs:

  • Opportunity ID (Required): ID to delete

Business / Company Management

Create Business/Company

Create a standalone business record in GoHighLevel.

Inputs:

  • Location ID (Required): Location for the business
  • Name (Required): Business name
  • Email / Phone / Website: Contact details
  • Address / City / State / Postal Code / Country: Address fields
  • Description: Business description

Outputs

Returns the new business record with ID, name, contact details, address, and timestamps.

Use case: Create company records from enriched domain data so you can associate contacts to businesses.

Get Business/Company

Retrieve details of one business by ID.

Inputs:

  • Business ID (Required): ID of the business

Outputs

Returns business name, email, phone, website, full address, description, location ID, and timestamps.

Use case: Look up a business record to verify company details before creating a linked opportunity.

Get Businesses by Location

List all businesses in a location with pagination.

Inputs:

  • Location ID (Required): Location to query
  • Limit: Results per page
  • Skip: Number of records to skip

Outputs

Returns a list of business records with name, contact details, address, and timestamps.

Use case: Export all businesses from a client's sub-account for a quarterly account review.

Update Business/Company

Update an existing business record.

Inputs:

  • Business ID (Required): ID to update
  • Name / Email / Phone / Website / Address fields / Description: Fields to update

Outputs

Returns the updated business record.

Use case: Write enriched company data (phone, website, address) back to GoHighLevel after running a company enrichment action.

Delete Business/Company

Delete a business record by ID.

Inputs:

  • Business ID (Required): ID to delete

Calendar and Appointments

Get Calendars

List all calendars in a location.

Inputs:

  • Location ID (Required): Location to fetch calendars for
  • Group ID: Filter by calendar group
  • Show Drafted Calendars: Include drafts (default: true)

Outputs

Returns calendar records including ID, name, description, type, slug, slot duration/interval settings, booking rules, auto-confirm settings, team members, and recurring configuration.

Use case: Retrieve calendar IDs at the start of a workflow so downstream appointment-creation steps can reference the correct calendar.

Create Calendar

Create a new calendar in a location.

Inputs:

  • Location ID (Required): Location for the calendar
  • Calendar Name (Required): Display name
  • Description / Slug / Widget Slug: Identification fields
  • Calendar Type: round_robin, event, class_booking, collective, service_booking, personal
  • Slot Duration / Interval / Buffer: Scheduling parameters
  • Appointments Per Slot / Per Day: Capacity limits
  • Auto Confirm / Allow Reschedule / Allow Cancellation: Booking rules

Outputs

Returns the new calendar's ID, name, type, slot settings, and location configurations.

Use case: Programmatically create a demo calendar for each new client sub-account during onboarding.

Get Calendar Events

List calendar events filtered by time range and user/calendar/group.

Inputs:

  • Location ID (Required): Location to query
  • Start Time (ms) (Required): Start of range in milliseconds
  • End Time (ms) (Required): End of range in milliseconds
  • User ID / Calendar ID / Group ID: At least one is required to filter events

Outputs

Returns event records with ID, title, address/URL, appointment status, assigned user, notes, description, recurrence info, and timestamps.

Use case: Pull this week's appointments to identify contacts who have upcoming meetings and exclude them from cold outreach.

Create Appointment

Schedule a new appointment on a calendar.

Inputs:

  • Calendar ID (Required): Target calendar
  • Location ID (Required): Location for the appointment
  • Contact ID (Required): Contact to associate
  • Start Time (Required): ISO string with timezone offset
  • End Time: ISO string with timezone offset
  • Title / Description / Address: Appointment details
  • Meeting Location Type: custom, zoom, gmeet, phone, address, ms_teams
  • Appointment Status: new, confirmed, cancelled, showed, noshow, completed
  • Assigned User ID: Team member assignment
  • Recurrence Rule (RRule): iCalendar recurrence pattern

Outputs

Returns appointment ID, calendar ID, contact ID, start/end times, status, meeting location type, and recurrence info.

Use case: Automatically book a follow-up call when a contact fills out a qualifying form.

Get Appointment

Retrieve details of one appointment by event ID.

Inputs:

  • Event ID (Required): ID of the appointment

Outputs

Returns the full appointment record with title, status, times, calendar and location IDs, contact ID, recurrence, and assigned resources.

Use case: Check an appointment's status before sending a reminder message to the contact.

Conversations and Messaging

Send Message

Send an outbound message (SMS, Email, WhatsApp, or others) or add an internal comment.

Inputs:

  • Contact ID (Required): Recipient contact
  • Message Type (Required): SMS, Email, WhatsApp, IG, FB, Custom, Live_Chat, InternalComment
  • Status (Required): pending, delivered, read, or failed
  • Message Body: Text content
  • Email Subject / HTML Content: For email messages
  • From Email / To Email / From Number / To Number: Sender and recipient overrides
  • Attachments: Array of attachment URLs
  • Template ID / Thread ID / Scheduled Timestamp: Advanced options

Add Inbound Message

Log an inbound message to a conversation or contact record.

Inputs:

  • Message Type (Required): SMS, Email, WhatsApp, GMB, IG, FB, Custom, WebChat, Live_Chat, Call
  • Conversation Provider ID (Required): Provider identifier
  • Conversation ID or Contact ID (Required): Target for the message
  • Message Body / HTML / Subject: Content fields
  • From Email / To Email: Email routing
  • Direction: inbound or outbound
  • Date: Message date

Update Message Status

Update the delivery or read status of a message.

Inputs:

  • Message ID (Required): ID of the message
  • Status (Required): delivered, failed, pending, or read
  • Email Message ID: For email-specific updates

Get Conversation

Retrieve details of a single conversation by ID.

Inputs:

  • Conversation ID (Required): ID of the conversation

Outputs

Returns conversation ID, contact ID, location ID, last message details, unread count, and status flags.

Use case: Check whether a conversation is still open before adding a new outbound message.

Search Conversations

Search conversations in a location with filters and pagination.

Inputs:

  • Location ID (Required): Location to search
  • Query: Keyword search
  • Contact ID / Assigned To / Status: Filter parameters
  • Limit / Sort / Sort By: Pagination and ordering

Outputs

Returns conversation records with contact details, last message info, and status.

Use case: Find all unread conversations assigned to a specific team member for a daily digest report.

Get Conversation Messages

Fetch all messages in a specific conversation.

Inputs:

  • Conversation ID (Required): Target conversation
  • Limit: Messages per page
  • Message Type: Filter by type (SMS, Email, etc.)
  • Message Type: Filter by type (SMS, Email, etc.)
  • Last Message ID: Cursor for pagination

Outputs

Returns message records with ID, body, type, direction, status, sender/recipient details, and timestamps.

Use case: Export a full conversation thread to analyze response times and message sentiment.

Tags and Custom Fields

Add Tag

Add a tag to a contact.

Inputs:

  • Contact ID (Required): Contact to tag
  • Tag (Required): Tag label to add

Remove Tag

Remove a specific tag from a contact.

Inputs:

  • Contact ID (Required): Contact to update
  • Tag (Required): Tag label to remove

Get Tags

List all tags defined in a location.

Inputs:

  • Location ID (Required): Location to query

Outputs

Returns tag IDs and names for the location.

Use case: Pull all available tags at the start of a workflow to validate tag names before applying them.

Get Custom Fields

List all custom fields for a location.

Inputs:

  • Location ID (Required): Location to query
  • Model: Filter by object type (e.g., contact, opportunity)

Outputs

Returns custom field IDs, names, field keys, data types, placeholder text, and position order.

Use case: Retrieve custom field IDs so you can write enrichment data to the correct fields when updating contacts.

Get Custom Values

List all custom values for a location.

Inputs:

  • Location ID (Required): Location to query

Outputs

Returns custom value IDs, names, and values.

Use case: Look up reusable custom values (e.g., company address snippets) to reference in outbound messages.

Workflows, Tasks, Notes, and Pipelines

Get Workflows

List all workflows in a location.

Inputs:

  • Location ID (Required): Location to query

Get All Tasks

List all tasks associated with a contact.

Inputs:

  • Contact ID (Required): Contact to query

Outputs

Returns task records with ID, title, body, assignee, status, due date, and completion status.

Use case: Check for overdue tasks on a contact before scheduling a new follow-up action.

Get All Notes

List all notes on a contact record.

Inputs:

  • Contact ID (Required): Contact to query

Outputs

Returns note records with ID, body, user ID, and timestamps.

Use case: Pull existing notes before appending enrichment findings as a new note on the contact.

Get Pipelines

List all pipelines in a location.

Inputs:

  • Location ID (Required): Location to query

Outputs

Returns pipeline records with ID, name, stages (each with stage ID, name, and position), and location ID.

Use case: Retrieve pipeline and stage IDs before creating or moving opportunities in a multi-step workflow.

Location / Sub-Account Management

Get Sub-Account / Location

Retrieve full details of one sub-account by Location ID.

Inputs:

  • Location ID (Required): ID of the sub-account

Outputs

Returns location name, company ID, domain, full address, contact details (first name, last name, email, phone), website, timezone, logo URL, business details, social media URLs, and duplicate settings.

Use case: Pull a client sub-account's contact info and social URLs for a campaign setup checklist.

Search Locations

Search and list sub-accounts within a company/agency.

Inputs:

  • Company/Agency ID: Agency to search within
  • Email: Filter by email
  • Skip: Pagination offset (default: 0)
  • Limit: Results per page (default: 10)
  • Order: asc or desc

Outputs

Returns location records with ID, name, contact details, full address, website, timezone, social URLs, and duplicate/contact settings.

Use case: List all sub-accounts in your agency to build a location inventory report.

Troubleshooting

"Unauthorized" or "Invalid API Key" error on all actions Your API key has expired or lacks the required scopes. Go to Settings > Integrations in TexAu and re-enter a valid LeadConnector API key.

Create Contact fails with "duplicate contact" error The location's duplicate contact settings block creation when a matching email or phone exists. Use the Upsert Contact action instead, or set Create New If Duplicate Allowed to true.

Search Contacts or Search Opportunities returns no results Confirm the Location ID is correct. The search query is limited to 75 characters. If using filters, verify the field name and operator match the expected values.

Create Appointment fails with "slot not available" The requested time slot is already booked or outside the calendar's availability window. Set Ignore Free Slot Validation to true to bypass slot checks, or choose a different time.

Opportunity actions return "pipeline not found" The Pipeline ID or Pipeline Stage ID is invalid. Run Get Pipelines first to retrieve valid IDs for the location.