CiviCRM

Interact with CiviCRM API v4 (Civi-Go compatible). Supports Contact, Membership, Group, Relationship and Activity entities. Includes dynamic mapping of email, phone, address and location types. Includes birth_date validation and JSON filters for GET MANY.
Join our community

Actions30

Overview

This node interacts with the CiviCRM API v4 to create a new Contact entity. It supports creating contacts of different types such as Individual, Organization, or Household. The node allows setting various contact details including email, phone, and address with customizable location types (e.g., Home, Work, Other). It also supports marking these details as primary. This node is useful for automating the addition of new contacts into a CiviCRM system, for example, when integrating with other systems or forms that collect contact information.

Use Case Examples

  1. Automatically create a new individual contact in CiviCRM when a form is submitted on a website.
  2. Add organizational contacts from an external database into CiviCRM with specific email and phone location types.
  3. Create household contacts with primary address and phone details for event management.

Properties

Name Meaning
Contact Type Specifies the type of contact to create, such as Individual, Organization, or Household.
Email Location Type Defines the location type for the email address, e.g., Home, Work, or Other.
Phone Location Type Defines the location type for the phone number, e.g., Home, Work, Mobile, or Other.
Address Location Type Defines the location type for the address, e.g., Home, Work, Billing, or Other.
Mark as Primary Boolean flag to mark the email, phone, or address as the primary contact detail.
Fields A collection of custom fields to set on the contact, each with a name and value.

Output

JSON

  • id - Unique identifier of the created contact.
  • display_name - Display name of the contact.
  • first_name - First name of the contact (if applicable).
  • last_name - Last name of the contact (if applicable).
  • contact_type - Type of the contact (Individual, Organization, Household).
  • gender_id - Gender identifier of the contact.
  • gender_id:name - Name of the gender associated with the contact.
  • birth_date - Birth date of the contact.
  • emails - List of email addresses associated with the contact.
  • phones - List of phone numbers associated with the contact.
  • addresses - List of addresses associated with the contact.

Dependencies

  • Requires an API key credential for authenticating with the CiviCRM API v4.

Troubleshooting

  • Invalid birth_date format error: Ensure the birth_date field is in a valid date format (YYYY-MM-DD preferred).
  • Failed to create contact error: Check API credentials and ensure the CiviCRM instance is reachable.
  • Primary contact detail deletion error: When marking a new primary email, phone, or address, the node deletes existing primary entries; ensure the contact has existing details to avoid errors.

Links

Discussion