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 manage Relationship entities, specifically supporting the deletion operation. It allows users to delete a Relationship record by specifying its ID. This is useful in scenarios where relationships between contacts or entities in CiviCRM need to be removed programmatically, such as cleaning up outdated or incorrect relationship data.
Use Case Examples
- Deleting a Relationship by its ID to remove an association between two contacts.
- Automating the cleanup of relationships in bulk by iterating over IDs and deleting them.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the Relationship entity to delete. This property is required for the delete operation. |
Output
JSON
success- Indicates if the delete operation was successful (true/false).message- A message confirming the deletion of the Relationship with the specified ID.deleted_id- The ID of the Relationship that was deleted.api_response- The raw response from the CiviCRM API after the delete request.
Dependencies
- Requires an API key credential for authenticating with the CiviCRM API v4.
Troubleshooting
- Ensure the provided ID exists in the CiviCRM system; otherwise, the delete operation may fail or return an error.
- Verify that the API credentials have sufficient permissions to delete Relationship entities.
- Common error messages may include invalid ID errors or authorization failures; check the ID value and API token validity.
Links
- CiviCRM API v4 Documentation - Official documentation for the CiviCRM API v4, including details on the Relationship entity and delete operation.