HighLevel

App · 30 actions

Work with your HighLevel (GoHighLevel) sub-account: create, find and update contacts, tags, notes and tasks, move opportunities through pipelines, and book appointments on your calendars.

Actions

ActionWhat it does
Add note to contactAdd a note to a contact's record.
Add tags to contactAdd tags to a contact, keeping the ones it already has.
Add task to contactAdd a to-do with a due date to a contact.
Book appointmentBook an appointment on a calendar for a contact.
Create contactCreate a contact.
Create opportunityCreate an opportunity for a contact in a pipeline.
Create or update contactFind the contact with the same email or phone and update it, or create a new one.
Create tagCreate a tag in the sub-account that contacts can then carry.
Delete appointmentDelete an appointment from the calendar.
Delete contactDelete a contact, with its notes and tasks.
Delete opportunityDelete an opportunity.
Delete tagDelete a tag from the sub-account.
Delete taskDelete a task from a contact.
Get contactGet one contact with its details, tags and custom field values.
Get open appointment timesList the times a calendar can still be booked between two moments, at most 31 days apart.
Get opportunityGet one opportunity with its pipeline, stage, status and value.
Get sub-accountGet the connected HighLevel sub-account: its name, business address, time zone and contact details.
List calendarsList the sub-account's booking calendars with their ids and slot lengths.
List notes on contactList every note on a contact.
List pipelinesList the opportunity pipelines, each with its stages and their ids.
List tagsList every tag defined in the sub-account.
List tasks on contactList every task on a contact, done or not.
List team membersList the team members of the sub-account with their ids and emails.
Remove tags from contactRemove tags from a contact, keeping the others.
Search contactsFind contacts by name, email, phone or company, or list them all.
Search opportunitiesFind opportunities by text, pipeline, stage, status, contact or owner.
Update appointmentReschedule an appointment or change its title, status, host or location.
Update contactChange a contact's details.
Update opportunityChange an opportunity: rename it, move it to another stage or pipeline, mark it won or lost, or change its value or owner.
Update taskChange a task or mark it done.

Add note to contact

Add a note to a contact's record.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts' or an earlier step.
NotebodytextRequired
The text of the note.

Outputs

noteobject
The note
Example output
{
  "note": {
    "body": "Called, wants a quote.",
    "contactId": "9NkT25Vor1v4aQatFsv2",
    "dateAdded": "2026-10-15T09:05:00.000Z",
    "id": "HGPcayliwcdoUFzvbTok",
    "userId": "YlWd2wuCAZQzh2cH1fVZ"
  }
}

Add tags to contact

Add tags to a contact, keeping the ones it already has.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts' or an earlier step.
TagstagslistRequired
Tags to use. Pick existing ones or type new names: HighLevel creates a tag the first time it is used.

Outputs

contact_idtext
The contact changed
tagslist
Every tag the contact now has
Example output
{
  "contact_id": "9NkT25Vor1v4aQatFsv2",
  "tags": [
    "lead",
    "vip"
  ]
}

Add task to contact

Add a to-do with a due date to a contact.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts' or an earlier step.
TitletitletextRequired
What needs doing.
Duedue_datedate and timeRequired
When the task is due.
Descriptionbodytext
What the task involves.
Assigned toassigned_totext
The team member who owns it. Pick one, or give their id.
Already donecompletedtrue/false
Turn on to add it as completed.Default: false.

Outputs

taskobject
The task
Example output
{
  "task": {
    "assignedTo": "YlWd2wuCAZQzh2cH1fVZ",
    "body": "Include the annual option.",
    "completed": false,
    "contactId": "9NkT25Vor1v4aQatFsv2",
    "dueDate": "2026-10-20T14:00:00.000Z",
    "id": "lJpzYrWdpkC2hX6t2yue",
    "title": "Send quote"
  }
}

Book appointment

Book an appointment on a calendar for a contact. Use 'Get open appointment times' to find a time the calendar offers.

Inputs

Calendarcalendar_idtextRequired
The calendar. Pick one, or give its id from an earlier step.
Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts' or an earlier step.
Startstart_timedate and timeRequired
When the appointment starts.
Endend_timedate and time
When it ends. Leave empty for the calendar's usual length.
Titletitletext
The appointment's title.
Descriptiondescriptiontext
Notes about the appointment.
Locationaddresstext
Where it takes place: an address or a meeting link.
Statusstatustext
The appointment's status. HighLevel's default for a new one is New.One of: new, confirmed, cancelled, showed, noshow (No-show), invalid.
Team memberassigned_user_idtext
The team member who hosts it. Pick one, or give their id.
Run automations and notificationsnotifytrue/false
Turn off to book without triggering the sub-account's workflows and reminders. Leave empty for HighLevel's default (on).
Book even if the time is not openignore_availabilitytrue/false
Turn on to book outside the calendar's opening hours and notice rules. Leave off to book only at an open time.

Outputs

appointmentobject
The appointment
Example output
{
  "appointment": {
    "address": "https://meet.example.com/intro",
    "appointmentStatus": "confirmed",
    "assignedUserId": "YlWd2wuCAZQzh2cH1fVZ",
    "calendarId": "BqTwX8QFwXzpegMve9EQ",
    "contactId": "9NkT25Vor1v4aQatFsv2",
    "dateAdded": "2026-10-15T09:00:00.000Z",
    "id": "YS3jaqqeehkR2Is80miy",
    "isRecurring": false,
    "locationId": "ve9EPM428h8vShlRW1KT",
    "status": "booked",
    "title": "Intro call"
  }
}

Create contact

Create a contact. Give at least a name, email or phone. If the sub-account does not allow duplicates, a matching contact makes this fail: use 'Upsert contact' to update it instead.

Inputs

First namefirst_nametext
The contact's first name.
Last namelast_nametext
The contact's last name.
Emailemailtext
The contact's email address.
Phonephonetext
The contact's phone number, with the country code if you can.
Companycompany_nametext
The company the contact works for.
Sourcesourcetext
Where the contact came from, such as Website or Referral.
Date of birthdate_of_birthdate
The contact's birth date.
Street addressaddress1text
The first line of the contact's address.
Citycitytext
The contact's city.
Statestatetext
The contact's state or region.
Postal codepostal_codetext
The contact's postal or ZIP code.
Countrycountrytext
The contact's country as a two-letter code, such as US or GB.
Websitewebsitetext
The contact's website.
Time zonetimezonetext
The contact's time zone, such as America/New_York.
Assigned toassigned_totext
The team member who owns it. Pick one, or give their id.
Custom fieldscustom_fieldsobject
Values for your own contact fields. Fill in only what should change. Checkboxes and multiple choice take comma-separated values.
Tagstagslist
Tags to put on the new contact. Type a new name to create a tag.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "address1": "2 High Street",
    "assignedTo": "YlWd2wuCAZQzh2cH1fVZ",
    "city": "Austin",
    "companyName": "Acme",
    "contactName": "jo bloggs",
    "country": "US",
    "customFields": [
      {
        "id": "6dvNaf7VhkQ9snc5vnjJ",
        "value": "Gold"
      }
    ],
    "dateAdded": "2026-10-15T09:00:00.000Z",
    "dateOfBirth": "1990-09-25",
    "dateUpdated": "2026-10-15T09:00:00.000Z",
    "dnd": false,
    "email": "jo@example.com",
    "firstName": "Jo",
    "id": "9NkT25Vor1v4aQatFsv2",
    "lastName": "Bloggs",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "phone": "+15555550123",
    "postalCode": "78701",
    "source": "Website",
    "state": "TX",
    "tags": [
      "lead"
    ],
    "timezone": "America/Chicago",
    "type": "lead",
    "website": "https://example.com"
  }
}

Create opportunity

Create an opportunity for a contact in a pipeline.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts' or an earlier step.
NamenametextRequired
The opportunity's name.
Pipelinepipeline_idtextRequired
The pipeline. Pick one, or give its id from 'List pipelines'.
Stagestage_idtext
The stage in the pipeline. Pick the pipeline first.
Statusstatustext
Where the opportunity stands. Defaults to open.One of: open, won, lost, abandoned. Default: open.
Valuemonetary_valuenumber
What the opportunity is worth, in the sub-account's currency.At least 0.
Assigned toassigned_totext
The team member who owns it. Pick one, or give their id.
Custom fieldscustom_fieldsobject
Values for your own opportunity fields. Fill in only what should change. Checkboxes and multiple choice take comma-separated values.

Outputs

opportunityobject
The opportunity
Example output
{
  "opportunity": {
    "assignedTo": "YlWd2wuCAZQzh2cH1fVZ",
    "contactId": "9NkT25Vor1v4aQatFsv2",
    "createdAt": "2026-10-15T09:10:00.000Z",
    "customFields": [
      {
        "fieldValue": "Gold",
        "id": "6dvNaf7VhkQ9snc5vnjJ"
      }
    ],
    "id": "yWQobCRIhRguQtD2llvk",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "monetaryValue": 500,
    "name": "Website redesign",
    "pipelineId": "aWdODOBVOlH1RUFKWQke",
    "pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
    "source": "Website",
    "status": "open",
    "updatedAt": "2026-10-15T09:10:00.000Z"
  }
}

Create or update contact

Find the contact with the same email or phone and update it, or create a new one. Needs an email or phone.

Inputs

First namefirst_nametext
The contact's first name.
Last namelast_nametext
The contact's last name.
Emailemailtext
The contact's email address.
Phonephonetext
The contact's phone number, with the country code if you can.
Companycompany_nametext
The company the contact works for.
Sourcesourcetext
Where the contact came from, such as Website or Referral.
Date of birthdate_of_birthdate
The contact's birth date.
Street addressaddress1text
The first line of the contact's address.
Citycitytext
The contact's city.
Statestatetext
The contact's state or region.
Postal codepostal_codetext
The contact's postal or ZIP code.
Countrycountrytext
The contact's country as a two-letter code, such as US or GB.
Websitewebsitetext
The contact's website.
Time zonetimezonetext
The contact's time zone, such as America/New_York.
Assigned toassigned_totext
The team member who owns it. Pick one, or give their id.
Custom fieldscustom_fieldsobject
Values for your own contact fields. Fill in only what should change. Checkboxes and multiple choice take comma-separated values.

Outputs

contactobject
The contact
createdtrue/false
True if a new contact was made, false if one was updated
Example output
{
  "contact": {
    "address1": "2 High Street",
    "assignedTo": "YlWd2wuCAZQzh2cH1fVZ",
    "city": "Austin",
    "companyName": "Acme",
    "contactName": "jo bloggs",
    "country": "US",
    "customFields": [
      {
        "id": "6dvNaf7VhkQ9snc5vnjJ",
        "value": "Gold"
      }
    ],
    "dateAdded": "2026-10-15T09:00:00.000Z",
    "dateOfBirth": "1990-09-25",
    "dateUpdated": "2026-10-15T09:00:00.000Z",
    "dnd": false,
    "email": "jo@example.com",
    "firstName": "Jo",
    "id": "9NkT25Vor1v4aQatFsv2",
    "lastName": "Bloggs",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "phone": "+15555550123",
    "postalCode": "78701",
    "source": "Website",
    "state": "TX",
    "tags": [
      "lead"
    ],
    "timezone": "America/Chicago",
    "type": "lead",
    "website": "https://example.com"
  },
  "created": true
}

Create tag

Create a tag in the sub-account that contacts can then carry.

Inputs

NamenametextRequired
The tag's name.

Outputs

tagobject
The tag
Example output
{
  "tag": {
    "id": "tag01HXAMPLE",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "name": "lead"
  }
}

Delete appointment

Delete an appointment from the calendar.

Inputs

Appointment IDevent_idtextRequired
The appointment's id, from 'Book appointment' or an earlier step.

Outputs

deletedtrue/false
Always true once deleted
event_idtext
The id of the appointment deleted
Example output
{
  "deleted": true,
  "event_id": "YS3jaqqeehkR2Is80miy"
}

Delete contact

Delete a contact, with its notes and tasks. This cannot be undone.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts' or an earlier step.

Outputs

contact_idtext
The id of the contact deleted
deletedtrue/false
Always true once deleted
Example output
{
  "contact_id": "9NkT25Vor1v4aQatFsv2",
  "deleted": true
}

Delete opportunity

Delete an opportunity. This cannot be undone.

Inputs

Opportunity IDopportunity_idtextRequired
The opportunity's id, from 'Search opportunities' or an earlier step.

Outputs

deletedtrue/false
Always true once deleted
opportunity_idtext
The id of the opportunity deleted
Example output
{
  "deleted": true,
  "opportunity_id": "yWQobCRIhRguQtD2llvk"
}

Delete tag

Delete a tag from the sub-account. Contacts that carry it lose it.

Inputs

Tagtag_idtextRequired
The tag to delete. Pick one, or give its id.

Outputs

deletedtrue/false
Always true once deleted
tag_idtext
The id of the tag deleted
Example output
{
  "deleted": true,
  "tag_id": "tag01HXAMPLE"
}

Delete task

Delete a task from a contact.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts' or an earlier step.
Task IDtask_idtextRequired
The task's id, from 'List tasks' or 'Create task'.

Outputs

deletedtrue/false
Always true once deleted
task_idtext
The id of the task deleted
Example output
{
  "deleted": true,
  "task_id": "lJpzYrWdpkC2hX6t2yue"
}

Get contact

Get one contact with its details, tags and custom field values.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts' or an earlier step.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "address1": "2 High Street",
    "assignedTo": "YlWd2wuCAZQzh2cH1fVZ",
    "city": "Austin",
    "companyName": "Acme",
    "contactName": "jo bloggs",
    "country": "US",
    "customFields": [
      {
        "id": "6dvNaf7VhkQ9snc5vnjJ",
        "value": "Gold"
      }
    ],
    "dateAdded": "2026-10-15T09:00:00.000Z",
    "dateOfBirth": "1990-09-25",
    "dateUpdated": "2026-10-15T09:00:00.000Z",
    "dnd": false,
    "email": "jo@example.com",
    "firstName": "Jo",
    "id": "9NkT25Vor1v4aQatFsv2",
    "lastName": "Bloggs",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "phone": "+15555550123",
    "postalCode": "78701",
    "source": "Website",
    "state": "TX",
    "tags": [
      "lead"
    ],
    "timezone": "America/Chicago",
    "type": "lead",
    "website": "https://example.com"
  }
}

Get open appointment times

List the times a calendar can still be booked between two moments, at most 31 days apart. 'first_slot' is the earliest.

Inputs

Calendarcalendar_idtextRequired
The calendar. Pick one, or give its id from an earlier step.
Fromstart_timedate and timeRequired
The start of the window to look in.
Untilend_timedate and timeRequired
The end of the window, at most 31 days after the start.
Time zonetimezonetext
The time zone the times come back in, such as America/New_York. Defaults to the calendar's.
Team memberstaff_idtext
Only times this team member is free. Pick one, or give their id.

Outputs

day_countnumber
How many days have open times
dayslist
Each day with open times
first_slottext
The earliest open time, empty if there is none
slot_countnumber
How many open times in all
Example output
{
  "day_count": 1,
  "days": [
    {
      "date": "2026-10-20",
      "slots": [
        "2026-10-20T09:00:00-05:00",
        "2026-10-20T09:30:00-05:00"
      ]
    }
  ],
  "first_slot": "2026-10-20T09:00:00-05:00",
  "slot_count": 2
}

Get opportunity

Get one opportunity with its pipeline, stage, status and value.

Inputs

Opportunity IDopportunity_idtextRequired
The opportunity's id, from 'Search opportunities' or an earlier step.

Outputs

opportunityobject
The opportunity
Example output
{
  "opportunity": {
    "assignedTo": "YlWd2wuCAZQzh2cH1fVZ",
    "contactId": "9NkT25Vor1v4aQatFsv2",
    "createdAt": "2026-10-15T09:10:00.000Z",
    "customFields": [
      {
        "fieldValue": "Gold",
        "id": "6dvNaf7VhkQ9snc5vnjJ"
      }
    ],
    "id": "yWQobCRIhRguQtD2llvk",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "monetaryValue": 500,
    "name": "Website redesign",
    "pipelineId": "aWdODOBVOlH1RUFKWQke",
    "pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
    "source": "Website",
    "status": "open",
    "updatedAt": "2026-10-15T09:10:00.000Z"
  }
}

Get sub-account

Get the connected HighLevel sub-account: its name, business address, time zone and contact details.

Inputs

None.

Outputs

locationobject
The sub-account
Example output
{
  "location": {
    "address": "1 Main Street",
    "city": "Austin",
    "companyId": "5DP4iH6HLkQsiKESj6rh",
    "country": "US",
    "email": "hello@example.com",
    "id": "ve9EPM428h8vShlRW1KT",
    "name": "Acme Dental",
    "phone": "+15555550100",
    "postalCode": "78701",
    "state": "TX",
    "timezone": "America/Chicago",
    "website": "https://example.com"
  }
}

List calendars

List the sub-account's booking calendars with their ids and slot lengths.

Inputs

None.

Outputs

calendarslist
The calendars
countnumber
How many
Example output
{
  "calendars": [
    {
      "calendarType": "round_robin",
      "description": "A 30-minute first call.",
      "eventType": "RoundRobin_OptimizeForAvailability",
      "id": "BqTwX8QFwXzpegMve9EQ",
      "isActive": true,
      "locationId": "ve9EPM428h8vShlRW1KT",
      "name": "Intro calls",
      "slotDuration": 30,
      "slotDurationUnit": "mins",
      "slug": "intro-calls"
    }
  ],
  "count": 1
}

List notes on contact

List every note on a contact.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts' or an earlier step.

Outputs

countnumber
How many
noteslist
The notes
Example output
{
  "count": 1,
  "notes": [
    {
      "body": "Called, wants a quote.",
      "contactId": "9NkT25Vor1v4aQatFsv2",
      "dateAdded": "2026-10-15T09:05:00.000Z",
      "id": "HGPcayliwcdoUFzvbTok",
      "userId": "YlWd2wuCAZQzh2cH1fVZ"
    }
  ]
}

List pipelines

List the opportunity pipelines, each with its stages and their ids.

Inputs

None.

Outputs

countnumber
How many
pipelineslist
The pipelines
Example output
{
  "count": 1,
  "pipelines": [
    {
      "id": "aWdODOBVOlH1RUFKWQke",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "name": "Sales",
      "showInFunnel": true,
      "showInPieChart": true,
      "stages": [
        {
          "id": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
          "name": "New",
          "position": 0
        }
      ]
    }
  ]
}

List tags

List every tag defined in the sub-account.

Inputs

None.

Outputs

countnumber
How many
tagslist
The tags
Example output
{
  "count": 1,
  "tags": [
    {
      "id": "tag01HXAMPLE",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "name": "lead"
    }
  ]
}

List tasks on contact

List every task on a contact, done or not.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts' or an earlier step.

Outputs

countnumber
How many
taskslist
The tasks
Example output
{
  "count": 1,
  "tasks": [
    {
      "assignedTo": "YlWd2wuCAZQzh2cH1fVZ",
      "body": "Include the annual option.",
      "completed": false,
      "contactId": "9NkT25Vor1v4aQatFsv2",
      "dueDate": "2026-10-20T14:00:00.000Z",
      "id": "lJpzYrWdpkC2hX6t2yue",
      "title": "Send quote"
    }
  ]
}

List team members

List the team members of the sub-account with their ids and emails.

Inputs

None.

Outputs

countnumber
How many
userslist
The team members
Example output
{
  "count": 1,
  "users": [
    {
      "deleted": false,
      "email": "sam@example.com",
      "firstName": "Sam",
      "id": "YlWd2wuCAZQzh2cH1fVZ",
      "lastName": "Rivera",
      "name": "Sam Rivera",
      "phone": "+15555550101"
    }
  ]
}

Remove tags from contact

Remove tags from a contact, keeping the others.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts' or an earlier step.
TagstagslistRequired
Tags to use. Pick existing ones or type new names: HighLevel creates a tag the first time it is used.

Outputs

contact_idtext
The contact changed
tagslist
Every tag the contact now has
Example output
{
  "contact_id": "9NkT25Vor1v4aQatFsv2",
  "tags": [
    "lead"
  ]
}

Search contacts

Find contacts by name, email, phone or company, or list them all. Returns one page; ask for the next with 'page'.

Inputs

Search textquerytext
Part of a name, email, phone number or company. Leave empty for all contacts.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 20.From 1 to 100.
Pagepagenumber
Which page to return, starting at 1. Defaults to 1.At least 1.

Outputs

contactslist
The matching contacts
countnumber
How many are on this page
has_moretrue/false
True when a later page has more; ask for page + 1
pagenumber
The page number returned
totalnumber
How many match in all
Example output
{
  "contacts": [
    {
      "address1": "2 High Street",
      "assignedTo": "YlWd2wuCAZQzh2cH1fVZ",
      "city": "Austin",
      "companyName": "Acme",
      "contactName": "jo bloggs",
      "country": "US",
      "customFields": [
        {
          "id": "6dvNaf7VhkQ9snc5vnjJ",
          "value": "Gold"
        }
      ],
      "dateAdded": "2026-10-15T09:00:00.000Z",
      "dateOfBirth": "1990-09-25",
      "dateUpdated": "2026-10-15T09:00:00.000Z",
      "dnd": false,
      "email": "jo@example.com",
      "firstName": "Jo",
      "id": "9NkT25Vor1v4aQatFsv2",
      "lastName": "Bloggs",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "phone": "+15555550123",
      "postalCode": "78701",
      "source": "Website",
      "state": "TX",
      "tags": [
        "lead"
      ],
      "timezone": "America/Chicago",
      "type": "lead",
      "website": "https://example.com"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1,
  "total": 1
}

Search opportunities

Find opportunities by text, pipeline, stage, status, contact or owner. Returns one page; ask for the next with 'page'.

Inputs

Search textquerytext
Only opportunities whose name or contact matches this text.
Pipelinepipeline_idtext
Only opportunities in this pipeline.
Stagestage_idtext
Only opportunities in this stage, named with its pipeline.
Statusstatustext
Only opportunities with this status. Defaults to any.One of: all (Any status (default)), open, won, lost, abandoned.
Contact IDcontact_idtext
Only opportunities for this contact.
Assigned toassigned_totext
Only opportunities owned by this team member.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 20.From 1 to 100.
Pagepagenumber
Which page to return, starting at 1. Defaults to 1.At least 1.

Outputs

countnumber
How many are on this page
has_moretrue/false
True when a later page has more; ask for page + 1
opportunitieslist
The matching opportunities
pagenumber
The page number returned
totalnumber
How many match in all
Example output
{
  "count": 1,
  "has_more": false,
  "opportunities": [
    {
      "assignedTo": "YlWd2wuCAZQzh2cH1fVZ",
      "contactId": "9NkT25Vor1v4aQatFsv2",
      "createdAt": "2026-10-15T09:10:00.000Z",
      "customFields": [
        {
          "fieldValue": "Gold",
          "id": "6dvNaf7VhkQ9snc5vnjJ"
        }
      ],
      "id": "yWQobCRIhRguQtD2llvk",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "monetaryValue": 500,
      "name": "Website redesign",
      "pipelineId": "aWdODOBVOlH1RUFKWQke",
      "pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
      "source": "Website",
      "status": "open",
      "updatedAt": "2026-10-15T09:10:00.000Z"
    }
  ],
  "page": 1,
  "total": 1
}

Update appointment

Reschedule an appointment or change its title, status, host or location. Only the fields you fill in change.

Inputs

Appointment IDevent_idtextRequired
The appointment's id, from 'Book appointment' or an earlier step.
Startstart_timedate and time
A new start. Leave empty to keep the current one.
Endend_timedate and time
A new end. Leave empty to keep the current one.
Titletitletext
The appointment's title.
Descriptiondescriptiontext
Notes about the appointment.
Locationaddresstext
Where it takes place: an address or a meeting link.
Statusstatustext
The appointment's status. HighLevel's default for a new one is New.One of: new, confirmed, cancelled, showed, noshow (No-show), invalid.
Team memberassigned_user_idtext
The team member who hosts it. Pick one, or give their id.
Run automations and notificationsnotifytrue/false
Turn off to book without triggering the sub-account's workflows and reminders. Leave empty for HighLevel's default (on).
Book even if the time is not openignore_availabilitytrue/false
Turn on to book outside the calendar's opening hours and notice rules. Leave off to book only at an open time.

Outputs

appointmentobject
The appointment
Example output
{
  "appointment": {
    "address": "https://meet.example.com/intro",
    "appointmentStatus": "showed",
    "assignedUserId": "YlWd2wuCAZQzh2cH1fVZ",
    "calendarId": "BqTwX8QFwXzpegMve9EQ",
    "contactId": "9NkT25Vor1v4aQatFsv2",
    "dateAdded": "2026-10-15T09:00:00.000Z",
    "id": "YS3jaqqeehkR2Is80miy",
    "isRecurring": false,
    "locationId": "ve9EPM428h8vShlRW1KT",
    "status": "booked",
    "title": "Intro call"
  }
}

Update contact

Change a contact's details. Only the fields you fill in change. Use 'Add tags to contact' to change tags.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts' or an earlier step.
First namefirst_nametext
The contact's first name.
Last namelast_nametext
The contact's last name.
Emailemailtext
The contact's email address.
Phonephonetext
The contact's phone number, with the country code if you can.
Companycompany_nametext
The company the contact works for.
Sourcesourcetext
Where the contact came from, such as Website or Referral.
Date of birthdate_of_birthdate
The contact's birth date.
Street addressaddress1text
The first line of the contact's address.
Citycitytext
The contact's city.
Statestatetext
The contact's state or region.
Postal codepostal_codetext
The contact's postal or ZIP code.
Countrycountrytext
The contact's country as a two-letter code, such as US or GB.
Websitewebsitetext
The contact's website.
Time zonetimezonetext
The contact's time zone, such as America/New_York.
Assigned toassigned_totext
The team member who owns it. Pick one, or give their id.
Custom fieldscustom_fieldsobject
Values for your own contact fields. Fill in only what should change. Checkboxes and multiple choice take comma-separated values.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "address1": "2 High Street",
    "assignedTo": "YlWd2wuCAZQzh2cH1fVZ",
    "city": "Austin",
    "companyName": "Acme",
    "contactName": "jo bloggs",
    "country": "US",
    "customFields": [
      {
        "id": "6dvNaf7VhkQ9snc5vnjJ",
        "value": "Gold"
      }
    ],
    "dateAdded": "2026-10-15T09:00:00.000Z",
    "dateOfBirth": "1990-09-25",
    "dateUpdated": "2026-10-15T09:00:00.000Z",
    "dnd": false,
    "email": "jo@example.com",
    "firstName": "Jo",
    "id": "9NkT25Vor1v4aQatFsv2",
    "lastName": "Bloggs",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "phone": "+15555550123",
    "postalCode": "78701",
    "source": "Website",
    "state": "TX",
    "tags": [
      "lead"
    ],
    "timezone": "America/Chicago",
    "type": "lead",
    "website": "https://example.com"
  }
}

Update opportunity

Change an opportunity: rename it, move it to another stage or pipeline, mark it won or lost, or change its value or owner. Only the fields you fill in change.

Inputs

Opportunity IDopportunity_idtextRequired
The opportunity's id, from 'Search opportunities' or an earlier step.
Namenametext
A new name. Leave empty to keep the current one.
Pipelinepipeline_idtext
Move it to this pipeline. Leave empty to keep the current one.
Stagestage_idtext
Move it to this stage, named with its pipeline.
Statusstatustext
A new status. Leave empty to keep the current one.One of: open, won, lost, abandoned.
Valuemonetary_valuenumber
What the opportunity is worth, in the sub-account's currency.At least 0.
Assigned toassigned_totext
The team member who owns it. Pick one, or give their id.
Custom fieldscustom_fieldsobject
Values for your own opportunity fields. Fill in only what should change. Checkboxes and multiple choice take comma-separated values.

Outputs

opportunityobject
The opportunity
Example output
{
  "opportunity": {
    "assignedTo": "YlWd2wuCAZQzh2cH1fVZ",
    "contactId": "9NkT25Vor1v4aQatFsv2",
    "createdAt": "2026-10-15T09:10:00.000Z",
    "customFields": [
      {
        "fieldValue": "Gold",
        "id": "6dvNaf7VhkQ9snc5vnjJ"
      }
    ],
    "id": "yWQobCRIhRguQtD2llvk",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "monetaryValue": 500,
    "name": "Website redesign",
    "pipelineId": "aWdODOBVOlH1RUFKWQke",
    "pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
    "source": "Website",
    "status": "won",
    "updatedAt": "2026-10-15T09:10:00.000Z"
  }
}

Update task

Change a task or mark it done. Only the fields you fill in change.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts' or an earlier step.
Task IDtask_idtextRequired
The task's id, from 'List tasks' or 'Create task'.
Titletitletext
A new title. Leave empty to keep the current one.
Duedue_datedate and time
A new due date. Leave empty to keep the current one.
Descriptionbodytext
What the task involves.
Assigned toassigned_totext
The team member who owns it. Pick one, or give their id.
Donecompletedtrue/false
Turn on to mark it done, off to reopen it. Leave empty to keep it as it is.

Outputs

taskobject
The task
Example output
{
  "task": {
    "assignedTo": "YlWd2wuCAZQzh2cH1fVZ",
    "body": "Include the annual option.",
    "completed": true,
    "contactId": "9NkT25Vor1v4aQatFsv2",
    "dueDate": "2026-10-20T14:00:00.000Z",
    "id": "lJpzYrWdpkC2hX6t2yue",
    "title": "Send quote"
  }
}

On this page