HighLevel icon

HighLevel

Consume HighLevel API
Join our community

Actions16

Overview

The HighLevel node for n8n allows you to interact with the HighLevel API, specifically to create new contacts. This is useful in scenarios where you want to automate the process of adding leads or customers into your HighLevel CRM from other systems, such as when a new user signs up on your website, fills out a form, or is added via another workflow.

Practical examples:

  • Automatically add new newsletter subscribers as contacts in HighLevel.
  • Sync contacts from an e-commerce platform to HighLevel for marketing automation.
  • Enrich contact data by including custom fields and tags during creation.

Properties

Name Type Meaning
Email String The email address of the contact. Either Email or Phone is required to create a contact.
Phone String The phone number of the contact. Either Phone or Email is required to create a contact.
Additional Fields Collection Optional additional information about the contact, such as address, city, custom fields, do not disturb flag, first/last name, name, postal code, source, state, tags, timezone, and website. See below for details.

Additional Fields options:

  • Address (String): Street address of the contact.
  • City (String): City of the contact.
  • Custom Fields (Collection): Key-value pairs for custom field IDs and their values.
  • Do Not Disturb (Boolean): If true, no outbound messages are permitted.
  • First Name (String): First name of the contact.
  • Last Name (String): Last name of the contact.
  • Name (String): Full name of the contact.
  • Postal Code (String): Postal code of the contact.
  • Source (String): Source of the contact.
  • State (String): State of the contact.
  • Tags (String[], multi): Tags to assign to the contact.
  • Timezone (Options): Timezone of the contact.
  • Website (String): Website URL of the contact.

Output

The node returns a json object representing the newly created contact. The structure typically includes:

{
  "id": "string",
  "email": "string",
  "phone": "string",
  "firstName": "string",
  "lastName": "string",
  "name": "string",
  "address1": "string",
  "city": "string",
  "postalCode": "string",
  "state": "string",
  "tags": ["string"],
  "timezone": "string",
  "website": "string",
  "dnd": boolean,
  "source": "string",
  "customField.<fieldId>": "string",
  ...
}
  • All provided input fields will be reflected in the output.
  • Custom fields will appear as customField.<fieldId>: <value>.
  • The actual response may include additional metadata returned by the HighLevel API.

Dependencies

  • External Service: Requires access to the HighLevel API.
  • API Credentials: You must configure the highLevelApi credential in n8n with your HighLevel API key.
  • n8n Configuration: No special configuration beyond credentials is required.

Troubleshooting

Common Issues:

  • Missing Required Fields: If neither Email nor Phone is provided, the API will reject the request.
  • Invalid Custom Field ID: Supplying an incorrect custom field ID will result in an error from the API.
  • Authentication Errors: Invalid or missing API credentials will cause authentication failures.

Error Messages & Resolutions:

  • "400 Bad Request": Check that at least one of Email or Phone is provided and all required fields are correctly filled.
  • "401 Unauthorized": Ensure your HighLevel API credentials are set up correctly in n8n.
  • "404 Not Found" (for custom fields): Verify that the custom field IDs exist in your HighLevel account.

Links and References

Discussion