CiviCRM icon

CiviCRM

Interact with CiviCRM API v4 to manage contacts, memberships, groups, and more.

Actions33

Group → Delete

AI-generated

Summary

Deletes the CiviCRM group with the specified ID by calling the Group API v4 delete action. Uses the node credential unless a runtime bearer token or base URL override is provided.

Inputs

  • ID (required) — Internal CiviCRM ID of the group to delete.
  • Runtime Bearer Token (Optional) — Optional JWT sent as the bearer token for this call. When set, the node uses it without retrying with credential-based authentication if the request returns no data or an error.
  • Base URL Override — Optional CiviCRM site root for this item, without /civicrm. If omitted, uses the credential’s Base URL; a URL without a scheme is treated as HTTPS.

Output shape

A single item containing a deletion result object.

The object includes success: true, a message naming the deleted group and ID, deleted_id, and the raw CiviCRM API response in api_response. Request errors are thrown unless the node is configured to continue on fail, in which case an item with an error message is returned.

Links

Discussion