# HighLevel

> 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.

App · 30 actions. Web page: https://docs.lodol.com/docs/integrations/highlevel

## Actions

### Add note to contact

Add a note to a contact's record.

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from 'Search contacts' or an earlier step.
- Note (`body`, text, required): The text of the note.

**Outputs**

- `note` (object): The note

**Example output**

```json
{
  "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 ID (`contact_id`, text, required): The contact's id, from 'Search contacts' or an earlier step.
- Tags (`tags`, list, required): Tags to use. Pick existing ones or type new names: HighLevel creates a tag the first time it is used.

**Outputs**

- `contact_id` (text): The contact changed
- `tags` (list): Every tag the contact now has

**Example output**

```json
{
  "contact_id": "9NkT25Vor1v4aQatFsv2",
  "tags": [
    "lead",
    "vip"
  ]
}
```

### Add task to contact

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

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from 'Search contacts' or an earlier step.
- Title (`title`, text, required): What needs doing.
- Due (`due_date`, date and time, required): When the task is due.
- Description (`body`, text): What the task involves.
- Assigned to (`assigned_to`, text): The team member who owns it. Pick one, or give their id.
- Already done (`completed`, true/false): Turn on to add it as completed. Default: `false`.

**Outputs**

- `task` (object): The task

**Example output**

```json
{
  "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**

- Calendar (`calendar_id`, text, required): The calendar. Pick one, or give its id from an earlier step.
- Contact ID (`contact_id`, text, required): The contact's id, from 'Search contacts' or an earlier step.
- Start (`start_time`, date and time, required): When the appointment starts.
- End (`end_time`, date and time): When it ends. Leave empty for the calendar's usual length.
- Title (`title`, text): The appointment's title.
- Description (`description`, text): Notes about the appointment.
- Location (`address`, text): Where it takes place: an address or a meeting link.
- Status (`status`, text): The appointment's status. HighLevel's default for a new one is New. One of: `new`, `confirmed`, `cancelled`, `showed`, `noshow` (No-show), `invalid`.
- Team member (`assigned_user_id`, text): The team member who hosts it. Pick one, or give their id.
- Run automations and notifications (`notify`, true/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 open (`ignore_availability`, true/false): Turn on to book outside the calendar's opening hours and notice rules. Leave off to book only at an open time.

**Outputs**

- `appointment` (object): The appointment

**Example output**

```json
{
  "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 name (`first_name`, text): The contact's first name.
- Last name (`last_name`, text): The contact's last name.
- Email (`email`, text): The contact's email address.
- Phone (`phone`, text): The contact's phone number, with the country code if you can.
- Company (`company_name`, text): The company the contact works for.
- Source (`source`, text): Where the contact came from, such as Website or Referral.
- Date of birth (`date_of_birth`, date): The contact's birth date.
- Street address (`address1`, text): The first line of the contact's address.
- City (`city`, text): The contact's city.
- State (`state`, text): The contact's state or region.
- Postal code (`postal_code`, text): The contact's postal or ZIP code.
- Country (`country`, text): The contact's country as a two-letter code, such as US or GB.
- Website (`website`, text): The contact's website.
- Time zone (`timezone`, text): The contact's time zone, such as America/New_York.
- Assigned to (`assigned_to`, text): The team member who owns it. Pick one, or give their id.
- Custom fields (`custom_fields`, object): Values for your own contact fields. Fill in only what should change. Checkboxes and multiple choice take comma-separated values.
- Tags (`tags`, list): Tags to put on the new contact. Type a new name to create a tag.

**Outputs**

- `contact` (object): The contact

**Example output**

```json
{
  "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 ID (`contact_id`, text, required): The contact's id, from 'Search contacts' or an earlier step.
- Name (`name`, text, required): The opportunity's name.
- Pipeline (`pipeline_id`, text, required): The pipeline. Pick one, or give its id from 'List pipelines'.
- Stage (`stage_id`, text): The stage in the pipeline. Pick the pipeline first.
- Status (`status`, text): Where the opportunity stands. Defaults to open. One of: `open`, `won`, `lost`, `abandoned`. Default: `open`.
- Value (`monetary_value`, number): What the opportunity is worth, in the sub-account's currency. At least 0.
- Assigned to (`assigned_to`, text): The team member who owns it. Pick one, or give their id.
- Custom fields (`custom_fields`, object): Values for your own opportunity fields. Fill in only what should change. Checkboxes and multiple choice take comma-separated values.

**Outputs**

- `opportunity` (object): The opportunity

**Example output**

```json
{
  "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 name (`first_name`, text): The contact's first name.
- Last name (`last_name`, text): The contact's last name.
- Email (`email`, text): The contact's email address.
- Phone (`phone`, text): The contact's phone number, with the country code if you can.
- Company (`company_name`, text): The company the contact works for.
- Source (`source`, text): Where the contact came from, such as Website or Referral.
- Date of birth (`date_of_birth`, date): The contact's birth date.
- Street address (`address1`, text): The first line of the contact's address.
- City (`city`, text): The contact's city.
- State (`state`, text): The contact's state or region.
- Postal code (`postal_code`, text): The contact's postal or ZIP code.
- Country (`country`, text): The contact's country as a two-letter code, such as US or GB.
- Website (`website`, text): The contact's website.
- Time zone (`timezone`, text): The contact's time zone, such as America/New_York.
- Assigned to (`assigned_to`, text): The team member who owns it. Pick one, or give their id.
- Custom fields (`custom_fields`, object): Values for your own contact fields. Fill in only what should change. Checkboxes and multiple choice take comma-separated values.

**Outputs**

- `contact` (object): The contact
- `created` (true/false): True if a new contact was made, false if one was updated

**Example output**

```json
{
  "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**

- Name (`name`, text, required): The tag's name.

**Outputs**

- `tag` (object): The tag

**Example output**

```json
{
  "tag": {
    "id": "tag01HXAMPLE",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "name": "lead"
  }
}
```

### Delete appointment

Delete an appointment from the calendar.

**Inputs**

- Appointment ID (`event_id`, text, required): The appointment's id, from 'Book appointment' or an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `event_id` (text): The id of the appointment deleted

**Example output**

```json
{
  "deleted": true,
  "event_id": "YS3jaqqeehkR2Is80miy"
}
```

### Delete contact

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

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from 'Search contacts' or an earlier step.

**Outputs**

- `contact_id` (text): The id of the contact deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "contact_id": "9NkT25Vor1v4aQatFsv2",
  "deleted": true
}
```

### Delete opportunity

Delete an opportunity. This cannot be undone.

**Inputs**

- Opportunity ID (`opportunity_id`, text, required): The opportunity's id, from 'Search opportunities' or an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `opportunity_id` (text): The id of the opportunity deleted

**Example output**

```json
{
  "deleted": true,
  "opportunity_id": "yWQobCRIhRguQtD2llvk"
}
```

### Delete tag

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

**Inputs**

- Tag (`tag_id`, text, required): The tag to delete. Pick one, or give its id.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `tag_id` (text): The id of the tag deleted

**Example output**

```json
{
  "deleted": true,
  "tag_id": "tag01HXAMPLE"
}
```

### Delete task

Delete a task from a contact.

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from 'Search contacts' or an earlier step.
- Task ID (`task_id`, text, required): The task's id, from 'List tasks' or 'Create task'.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `task_id` (text): The id of the task deleted

**Example output**

```json
{
  "deleted": true,
  "task_id": "lJpzYrWdpkC2hX6t2yue"
}
```

### Get contact

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

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from 'Search contacts' or an earlier step.

**Outputs**

- `contact` (object): The contact

**Example output**

```json
{
  "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**

- Calendar (`calendar_id`, text, required): The calendar. Pick one, or give its id from an earlier step.
- From (`start_time`, date and time, required): The start of the window to look in.
- Until (`end_time`, date and time, required): The end of the window, at most 31 days after the start.
- Time zone (`timezone`, text): The time zone the times come back in, such as America/New_York. Defaults to the calendar's.
- Team member (`staff_id`, text): Only times this team member is free. Pick one, or give their id.

**Outputs**

- `day_count` (number): How many days have open times
- `days` (list): Each day with open times
- `first_slot` (text): The earliest open time, empty if there is none
- `slot_count` (number): How many open times in all

**Example output**

```json
{
  "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 ID (`opportunity_id`, text, required): The opportunity's id, from 'Search opportunities' or an earlier step.

**Outputs**

- `opportunity` (object): The opportunity

**Example output**

```json
{
  "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**

- `location` (object): The sub-account

**Example output**

```json
{
  "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**

- `calendars` (list): The calendars
- `count` (number): How many

**Example output**

```json
{
  "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 ID (`contact_id`, text, required): The contact's id, from 'Search contacts' or an earlier step.

**Outputs**

- `count` (number): How many
- `notes` (list): The notes

**Example output**

```json
{
  "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**

- `count` (number): How many
- `pipelines` (list): The pipelines

**Example output**

```json
{
  "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**

- `count` (number): How many
- `tags` (list): The tags

**Example output**

```json
{
  "count": 1,
  "tags": [
    {
      "id": "tag01HXAMPLE",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "name": "lead"
    }
  ]
}
```

### List tasks on contact

List every task on a contact, done or not.

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from 'Search contacts' or an earlier step.

**Outputs**

- `count` (number): How many
- `tasks` (list): The tasks

**Example output**

```json
{
  "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**

- `count` (number): How many
- `users` (list): The team members

**Example output**

```json
{
  "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 ID (`contact_id`, text, required): The contact's id, from 'Search contacts' or an earlier step.
- Tags (`tags`, list, required): Tags to use. Pick existing ones or type new names: HighLevel creates a tag the first time it is used.

**Outputs**

- `contact_id` (text): The contact changed
- `tags` (list): Every tag the contact now has

**Example output**

```json
{
  "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 text (`query`, text): Part of a name, email, phone number or company. Leave empty for all contacts.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 20. From 1 to 100.
- Page (`page`, number): Which page to return, starting at 1. Defaults to 1. At least 1.

**Outputs**

- `contacts` (list): The matching contacts
- `count` (number): How many are on this page
- `has_more` (true/false): True when a later page has more; ask for page + 1
- `page` (number): The page number returned
- `total` (number): How many match in all

**Example output**

```json
{
  "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 text (`query`, text): Only opportunities whose name or contact matches this text.
- Pipeline (`pipeline_id`, text): Only opportunities in this pipeline.
- Stage (`stage_id`, text): Only opportunities in this stage, named with its pipeline.
- Status (`status`, text): Only opportunities with this status. Defaults to any. One of: `all` (Any status (default)), `open`, `won`, `lost`, `abandoned`.
- Contact ID (`contact_id`, text): Only opportunities for this contact.
- Assigned to (`assigned_to`, text): Only opportunities owned by this team member.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 20. From 1 to 100.
- Page (`page`, number): Which page to return, starting at 1. Defaults to 1. At least 1.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): True when a later page has more; ask for page + 1
- `opportunities` (list): The matching opportunities
- `page` (number): The page number returned
- `total` (number): How many match in all

**Example output**

```json
{
  "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 ID (`event_id`, text, required): The appointment's id, from 'Book appointment' or an earlier step.
- Start (`start_time`, date and time): A new start. Leave empty to keep the current one.
- End (`end_time`, date and time): A new end. Leave empty to keep the current one.
- Title (`title`, text): The appointment's title.
- Description (`description`, text): Notes about the appointment.
- Location (`address`, text): Where it takes place: an address or a meeting link.
- Status (`status`, text): The appointment's status. HighLevel's default for a new one is New. One of: `new`, `confirmed`, `cancelled`, `showed`, `noshow` (No-show), `invalid`.
- Team member (`assigned_user_id`, text): The team member who hosts it. Pick one, or give their id.
- Run automations and notifications (`notify`, true/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 open (`ignore_availability`, true/false): Turn on to book outside the calendar's opening hours and notice rules. Leave off to book only at an open time.

**Outputs**

- `appointment` (object): The appointment

**Example output**

```json
{
  "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 ID (`contact_id`, text, required): The contact's id, from 'Search contacts' or an earlier step.
- First name (`first_name`, text): The contact's first name.
- Last name (`last_name`, text): The contact's last name.
- Email (`email`, text): The contact's email address.
- Phone (`phone`, text): The contact's phone number, with the country code if you can.
- Company (`company_name`, text): The company the contact works for.
- Source (`source`, text): Where the contact came from, such as Website or Referral.
- Date of birth (`date_of_birth`, date): The contact's birth date.
- Street address (`address1`, text): The first line of the contact's address.
- City (`city`, text): The contact's city.
- State (`state`, text): The contact's state or region.
- Postal code (`postal_code`, text): The contact's postal or ZIP code.
- Country (`country`, text): The contact's country as a two-letter code, such as US or GB.
- Website (`website`, text): The contact's website.
- Time zone (`timezone`, text): The contact's time zone, such as America/New_York.
- Assigned to (`assigned_to`, text): The team member who owns it. Pick one, or give their id.
- Custom fields (`custom_fields`, object): Values for your own contact fields. Fill in only what should change. Checkboxes and multiple choice take comma-separated values.

**Outputs**

- `contact` (object): The contact

**Example output**

```json
{
  "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 ID (`opportunity_id`, text, required): The opportunity's id, from 'Search opportunities' or an earlier step.
- Name (`name`, text): A new name. Leave empty to keep the current one.
- Pipeline (`pipeline_id`, text): Move it to this pipeline. Leave empty to keep the current one.
- Stage (`stage_id`, text): Move it to this stage, named with its pipeline.
- Status (`status`, text): A new status. Leave empty to keep the current one. One of: `open`, `won`, `lost`, `abandoned`.
- Value (`monetary_value`, number): What the opportunity is worth, in the sub-account's currency. At least 0.
- Assigned to (`assigned_to`, text): The team member who owns it. Pick one, or give their id.
- Custom fields (`custom_fields`, object): Values for your own opportunity fields. Fill in only what should change. Checkboxes and multiple choice take comma-separated values.

**Outputs**

- `opportunity` (object): The opportunity

**Example output**

```json
{
  "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 ID (`contact_id`, text, required): The contact's id, from 'Search contacts' or an earlier step.
- Task ID (`task_id`, text, required): The task's id, from 'List tasks' or 'Create task'.
- Title (`title`, text): A new title. Leave empty to keep the current one.
- Due (`due_date`, date and time): A new due date. Leave empty to keep the current one.
- Description (`body`, text): What the task involves.
- Assigned to (`assigned_to`, text): The team member who owns it. Pick one, or give their id.
- Done (`completed`, true/false): Turn on to mark it done, off to reopen it. Leave empty to keep it as it is.

**Outputs**

- `task` (object): The task

**Example output**

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