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 perform create operations on various CiviCRM entities such as Contact, Membership, Group, Relationship, and Activity. It is useful for automating the creation of records in CiviCRM, for example, adding new contacts with detailed information including emails, phones, and addresses. This node supports dynamic field mapping and validation, making it suitable for integrating CiviCRM with other systems or workflows.

Use Case Examples

  1. Creating a new contact with multiple emails, phone numbers, and addresses.
  2. Adding a new membership record to CiviCRM.
  3. Creating a new group or activity entry in CiviCRM.

Properties

Name Meaning
Fields A collection of fields to set on the created entity, each with a name and value. Supports multiple fields to define the data for the new record.

Output

JSON

  • id - The unique identifier of the created entity in CiviCRM.
  • display_name - The display name of the created contact or entity.
  • first_name - First name of the contact (if applicable).
  • last_name - Last name of the contact (if applicable).
  • contact_type - Type of contact (Individual, Organization, Household) if the resource is contact.
  • 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 - Array of email objects associated with the contact.
  • phones - Array of phone objects associated with the contact.
  • addresses - Array of address objects associated with the contact.

Dependencies

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

Troubleshooting

  • Invalid birth_date format errors can occur if the date is not in a recognized format; ensure dates are in YYYY-MM-DD or convertible formats.
  • Failure to create contact or entity may result from missing required fields or API authentication issues.
  • Errors parsing JSON in 'whereJson' parameter for filtering getMany operations; ensure valid JSON syntax.

Links

Discussion