AvantGuard - ClerkChat icon

AvantGuard - ClerkChat

AvantGuard - ClerkChat

Overview

This node operation updates an existing contact in a public-facing system. It allows users to modify key details of a contact such as their name, email address, and whether the contact is marked as public. Additionally, it supports adding extra metadata fields to enrich the contact's information.

Common scenarios for this node include:

  • Keeping contact records up-to-date in a CRM or contact management system.
  • Changing visibility status of contacts (e.g., making a contact public or private).
  • Adding custom metadata to contacts for segmentation or additional context.

For example, you might use this node to update a customer's email address after they notify you of a change, or to mark a contact as public so they appear in a shared directory.

Properties

Name Meaning
Id The unique identifier of the contact to update.
Name The full name of the contact.
Email The email address of the contact.
Public Boolean flag indicating whether the contact is public (true) or not (false).
Additional Body Fields Optional additional metadata fields for the contact, provided as JSON data.

Output

The node outputs JSON data representing the updated contact record after the operation completes successfully. This typically includes the contact's ID, updated fields (name, email, public status), and any additional metadata that was added.

If the node supports binary data output, it would represent associated files or attachments related to the contact, but based on the provided code and properties, this node focuses on JSON data only.

Dependencies

  • Requires an API authentication token or API key credential configured in n8n to authorize requests to the external contact management service.
  • The base URL for the API is set via credentials and must be correctly configured.
  • The node depends on an OpenAPI-based client library for request construction and execution.

Troubleshooting

  • Missing or invalid contact ID: Ensure the "Id" property is provided and corresponds to an existing contact; otherwise, the update will fail.
  • Invalid email format: The email field should be a valid email address; invalid formats may cause API errors.
  • Authentication errors: Verify that the API key or authentication token is correctly set up in n8n credentials.
  • Malformed JSON in Additional Body Fields: If providing additional metadata, ensure the JSON is well-formed to avoid parsing errors.
  • API endpoint issues: Confirm the base URL and network connectivity to the external API service.

Links and References

Discussion