CiviCRM icon

CiviCRM

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

Custom API Call → Delete (Legacy)

AI-generated

Summary

Sends a raw CiviCRM APIv4 call for the configured entity and action. Despite its “Delete (Legacy)” label, this operation uses the raw passthrough path; it does not automatically delete an entity.

Inputs

  • Entity (required) — CiviCRM APIv4 entity name, such as Contact or Membership.
  • Action (required) — APIv4 action to call. To delete records, use delete and provide suitable criteria in Params (JSON).
  • Params (JSON) — Valid JSON object passed as the APIv4 request parameters. The default is {"limit":25}; for a delete call, supply the parameters CiviCRM requires, such as a where condition.
  • Runtime Bearer Token (Optional) — Optional per-call JWT, often supplied by expression. When set, the request uses that token without retrying with credential authentication if the response is empty or fails; when blank, the node uses its credential authentication.
  • Base URL Override — Optional CiviCRM site root for this item, without /civicrm. Accepts only HTTP or HTTPS; if no scheme is given, HTTPS is assumed. Blank uses the credential’s Base URL.

Output shape

One item containing the raw CiviCRM API response for each input item.

The node sends a POST request to {Entity}/{Action} and passes the parsed Params (JSON) object as APIv4 parameters. Legacy delete selects this raw path, so deletion behavior depends on the configured Action and Params; the node does not return the fixed-resource delete confirmation shape.

Links

Discussion