HighLevel icon

HighLevel

Consume HighLevel API

Overview

This node allows you to update an existing Contact in the HighLevel CRM platform. It is useful for automating workflows where contact information needs to be kept up-to-date, such as syncing user profiles from other systems, updating contact preferences, or managing CRM data enrichment processes.

Example scenarios:

  • Automatically update a contact's email or phone number when they change it in another system.
  • Add or modify custom fields for segmentation or personalization.
  • Update tags or DND (Do Not Disturb) status based on user actions.

Properties

Name Type Meaning
Contact ID String The unique identifier of the contact to update. Required.
Update Fields Collection A group of fields to update on the contact. Each field below can be set individually as part of this group.
Address String The street address of the contact.
City String The city of the contact.
Custom Fields FixedCollection (multiple) Allows setting custom fields by specifying Field ID and Field Value pairs.
DND Boolean Whether the contact is marked as Do Not Disturb.
Email String The contact's email address.
First Name String The contact's first name.
Last Name String The contact's last name.
Name String The full name of the contact.
Phone String The contact's phone number.
Postal Code String The postal code of the contact.
State String The state or region of the contact.
Tags String[] List of tags to associate with the contact.
Timezone Options The timezone of the contact. Can be selected from a list or specified via expression.
Website String The contact's website URL.

Output

The node returns the updated contact object in the json output field. The structure typically includes all standard and custom fields of the contact after the update. Example:

{
  "id": "abc123",
  "name": "John Doe",
  "email": "john@example.com",
  "phone": "+1234567890",
  "address1": "123 Main St",
  "city": "Metropolis",
  "state": "NY",
  "postalCode": "10001",
  "tags": ["customer", "newsletter"],
  "dnd": false,
  "timezone": "America/New_York",
  "website": "https://example.com",
  "customField": {
    "fieldId1": "value1",
    "fieldId2": "value2"
  },
  ...
}

Note: The actual fields returned depend on the API response and which fields were updated.

Dependencies

  • External Service: Requires access to the HighLevel API.
  • API Key: You must configure n8n credentials for highLevelApi.
  • Environment: No special environment variables are required beyond n8n credential setup.

Troubleshooting

  • Missing or Invalid Contact ID: If the Contact ID is missing or incorrect, the node will fail with an error indicating that the contact could not be found. Ensure you provide a valid Contact ID.
  • Authentication Errors: If your API key is missing or invalid, you'll receive authentication errors. Double-check your n8n credential configuration.
  • Invalid Field Values: Providing values in the wrong format (e.g., non-boolean for DND, invalid email format) may result in API errors.
  • Custom Field Issues: If you specify a custom field ID that does not exist, the update may fail or the field may be ignored.

Links and References

Discussion