Close CRM icon

Close CRM

Consume Close CRM API

Bulk Action (Automation & Bulk Actions) → Bulk Delete

AI-generated

Overview

This node operation performs a bulk delete action on leads or contacts in Close CRM based on an advanced filtering query. It allows users to specify criteria to identify multiple records and delete them in bulk, which is useful for cleaning up or managing large datasets efficiently.

Use Case Examples

  1. Deleting all leads that match a specific search query to remove outdated or irrelevant data.
  2. Bulk deleting contacts that meet certain criteria, such as those who have unsubscribed or are duplicates.

Properties

Name Meaning
Search Query (s_query JSON) An advanced filtering query object in JSON format that identifies the leads or contacts to be deleted. This query defines the criteria for selecting records to act on.
Additional Fields Optional additional settings for the bulk delete operation, including whether to send a notification email when the action is complete, a limit on the number of records to process, and sorting specifications in JSON format.

Output

JSON

  • id - The unique identifier of the bulk delete action or the result returned by the Close CRM API.
  • success - Indicates whether the bulk delete operation was successful.

Dependencies

  • Requires an API key credential for Close CRM to authenticate and authorize API requests.

Troubleshooting

  • Ensure the Search Query (s_query) is a valid JSON object; invalid JSON will cause errors.
  • The Search Query is required to avoid deleting all leads or contacts unintentionally.
  • If the API returns an error, check that the API key credential is valid and has the necessary permissions.
  • A results limit of 0 means no limit; be cautious with this setting to avoid large unintended deletions.
  • If the node throws an error about missing parameters, verify that all required fields are correctly set.

Links

Discussion