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 operation updates an existing Contact in the CiviCRM system. It allows users to modify various contact details such as contact type (Individual, Organization, Household), email, phone, and address information with specific location types (e.g., Work, Home). It supports marking contact details as primary and handles complex nested fields for emails, phones, and addresses. This operation is useful for maintaining up-to-date contact records in a CRM system, ensuring accurate communication and data management.
Use Case Examples
- Updating a contact's email and phone number with specific location types and marking them as primary.
- Changing the contact type from Individual to Organization and updating address details accordingly.
Properties
| Name | Meaning |
|---|---|
| Contact Type | Specifies the type of contact being updated, such as Individual, Organization, or Household. |
| Email Location Type | Defines the location type for the email address being updated, e.g., Work, Home, or Other. |
| Phone Location Type | Defines the location type for the phone number being updated, e.g., Work, Home, Mobile, or Other. |
| Address Location Type | Defines the location type for the address being updated, e.g., Home, Work, Billing, or Other. |
| Mark as Primary | Boolean flag to mark the updated email, phone, or address as the primary contact detail. |
| ID | The unique identifier of the contact to update. |
| Fields | A collection of fields to update on the contact, each with a name and value. Supports nested fields for email, phone, and address details. |
Output
JSON
id- Unique identifier of the updated contact.display_name- Display name of the contact.first_name- First name of the contact.last_name- Last name of the contact.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 errors can occur if the date is not in a recognized format (YYYY-MM-DD, MM/DD/YYYY, etc.). Ensure the date is correctly formatted before updating.
- Errors may occur if the contact ID does not exist or is not provided; ensure the ID is valid and present.
- If the API request fails, check the API credentials and network connectivity to the CiviCRM instance.
Links
- CiviCRM API v4 Documentation - Official documentation for the CiviCRM API version 4 used by this node.