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.
Actions30
Overview
This node interacts with the CiviCRM API v4 to perform update operations on various CiviCRM entities such as Contact, Membership, Group, Relationship, and Activity. It allows users to update records by specifying the entity type (resource), the operation (update), and the fields to be updated, including handling complex nested fields like email, phone, and address with location types. This node is useful for automating updates to CRM data, such as modifying contact details, membership information, or other entity attributes within CiviCRM.
Use Case Examples
- Updating a contact's email and phone number with specified location types.
- Modifying membership details by updating custom fields.
- Changing group or activity information by specifying the record ID and new field values.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the record to update. Required for update operations. |
| Fields | A collection of fields to update on the specified record. Each field includes a name and a value. Supports multiple fields to be updated simultaneously. |
Output
JSON
jsonid- The unique identifier of the updated record.display_name- Display name of the updated record (e.g., contact or group name).first_name- First name of the contact (if applicable).last_name- Last name of the contact (if applicable).contact_type- Type of contact (e.g., 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 records associated with the contact.phones- List of phone records associated with the contact.addresses- List of address records associated with the contact.
Dependencies
- CiviCRM API v4 endpoint
- API authentication token (API key credential)
Troubleshooting
- Ensure the ID provided exists in the CiviCRM system; otherwise, the update will fail.
- Validate date fields like birth_date to be in the correct format (YYYY-MM-DD) to avoid errors.
- Check that the API authentication token is valid and has sufficient permissions to perform update operations.
- If updating contact-related fields like email, phone, or address, ensure location types are correctly specified to avoid data inconsistencies.
Links
- CiviCRM API v4 Documentation - Official documentation for CiviCRM API v4 endpoints and usage.