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 create a new Group entity within the CiviCRM system. It allows users to specify multiple custom fields for the Group, each with a name and value, enabling flexible creation of groups with various attributes. This node is beneficial for automating the management of groups in CiviCRM, such as creating new member groups, event groups, or organizational units programmatically.
Use Case Examples
- Creating a new group with custom attributes like 'Name' and 'Description' to organize contacts.
- Automating the creation of event-related groups in CiviCRM for better event management.
Properties
| Name | Meaning |
|---|---|
| Fields | A collection of custom fields to set on the Group entity. Each field has a 'Name' and a 'Value' allowing flexible attribute assignment. |
Output
JSON
jsonid- The unique identifier of the created Group.name- The name of the created Group.title- The title of the created Group.subject- The subject associated with the Group.display_name- The display name of the Group.
Dependencies
- Requires an API key credential for authenticating with the CiviCRM API v4.
Troubleshooting
- Ensure that the API credentials are correctly configured and have sufficient permissions to create Group entities in CiviCRM.
- Verify that the field names and values provided are valid and conform to the expected data types in CiviCRM.
- Common error: 'Failed to create contact.' indicates an issue with the creation process, possibly due to invalid data or API errors. Check the input fields and API response for details.
Links
- CiviCRM API v4 Documentation - Official documentation for the CiviCRM API v4, useful for understanding available endpoints and data structures.