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 perform various operations on CiviCRM entities such as Contact, Membership, Group, Relationship, and Activity. Specifically, for the 'Custom API Call' resource with the 'Delete' operation, it deletes an entity by its ID. This is useful for automating the removal of records from CiviCRM, such as deleting a contact or membership entry by specifying its unique ID.

Use Case Examples

  1. Deleting a contact by providing the contact's ID to remove it from the CiviCRM database.
  2. Deleting a membership record by specifying the membership ID to keep the CRM data up to date.

Properties

Name Meaning
ID The unique identifier of the entity to delete. This is a required numeric input used to specify which record to delete.

Output

JSON

  • success - Indicates whether the delete operation was successful (true/false).
  • message - A message confirming the deletion of the entity with its type and ID.
  • deleted_id - The ID of the entity 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.

Troubleshooting

  • Ensure the ID provided exists in the CiviCRM database; otherwise, the delete operation may fail or have no effect.
  • Check API authentication credentials if the node fails to connect or returns authorization errors.
  • Invalid or missing ID parameter will cause the node to throw an error or fail to delete the intended record.

Discussion