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 operations on various resources including Group. Specifically, for the Group resource with the Delete operation, it deletes a group entity by its ID. This is useful in scenarios where you need to programmatically remove groups from your CiviCRM database, such as cleaning up unused groups or automating group management workflows.

Use Case Examples

  1. Deleting a group by specifying its ID to remove it from the CRM system.
  2. Automating cleanup of groups that are no longer needed in the CRM.

Properties

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

Output

JSON

  • success - Indicates whether the delete operation was successful (true/false).
  • message - A message confirming the deletion of the group with its ID.
  • deleted_id - The ID of the group that was deleted.
  • api_response - The raw response from the CiviCRM API for 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.
  • Check API authentication credentials if the node fails to connect or perform the delete operation.
  • Invalid or missing ID parameter will cause the node to throw an error or fail to delete the group.

Discussion