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.

Overview

This node interacts with the CiviCRM API v4 to create a new Relationship entity. It allows users to specify multiple fields as name-value pairs to define the properties of the Relationship being created. This node is useful in scenarios where automated creation of relationships between contacts or other entities in CiviCRM is needed, such as linking contacts as family members, colleagues, or other relationship types.

Use Case Examples

  1. Automatically create a relationship between two contacts when a new contact is added.
  2. Set up relationships between members and organizations in a membership management workflow.

Properties

Name Meaning
Fields A collection of fields to set on the Relationship entity, each with a name and a value. Multiple fields can be specified to define the Relationship's attributes.

Output

JSON

  • id - The unique identifier of the created Relationship entity.
  • name - The name of the Relationship entity.
  • title - The title of the Relationship entity.
  • subject - The subject associated with the Relationship.
  • display_name - The display name of the Relationship entity.

Dependencies

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

Troubleshooting

  • Ensure that the API credentials are correctly configured and have sufficient permissions to create Relationship entities.
  • Verify that all required fields for the Relationship entity are provided and correctly formatted.
  • If the node throws an error about invalid field values, check that the field names and values conform to CiviCRM API expectations.

Discussion