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 update a Relationship entity. It allows users to specify the ID of the relationship to update and provide multiple fields with their names and values to modify the relationship's data. This is useful for maintaining accurate and up-to-date relationship records in CiviCRM, such as updating contact relationships or organizational links.

Use Case Examples

  1. Updating a relationship's type or status by specifying the relationship ID and new field values.
  2. Modifying custom fields of a relationship record in CiviCRM to reflect changes in organizational structure or contact connections.

Properties

Name Meaning
ID The unique identifier of the Relationship entity to update, required to specify which relationship to modify.
Fields A collection of field name and value pairs to update on the Relationship entity. Multiple fields can be updated in one operation.

Output

JSON

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

Dependencies

  • Requires an API key credential for CiviCRM API v4 authentication.

Troubleshooting

  • Ensure the provided Relationship ID exists in CiviCRM; otherwise, the update will fail.
  • Field names must be valid CiviCRM Relationship fields; invalid fields may cause errors or be ignored.
  • The node expects the 'fields' input as a collection of name-value pairs; incorrect formatting may cause the update to fail.
  • API authentication errors may occur if the API key credential is missing or invalid.

Links

Discussion