Close CRM icon

Close CRM

Consume Close CRM API

Actions83

Bulk Action (Automation & Bulk Actions) → Bulk Edit

AI-generated

Overview

This node operation performs bulk edit actions on records in Close CRM. It supports editing lead statuses or custom fields for multiple leads or contacts that match a specified advanced filtering query. Users can set a new lead status, set a custom field value, or clear a custom field across many records in one operation. Additional options include sending a notification email when the bulk action completes, limiting the number of records processed, and sorting the records before applying the edit.

Use Case Examples

  1. Set the lead status to 'Contacted' for all leads matching a specific search query.
  2. Update a custom multi-value field by adding a new value to all matching contacts.
  3. Clear a custom field for a subset of leads filtered by an advanced JSON query.

Properties

Name Meaning
Edit Type The kind of edit to perform on each matching record, such as setting lead status, setting a custom field, or clearing a custom field.
Lead Status The lead status to assign when the edit type is 'Set Lead Status'. This is selected from available lead statuses or specified by ID.
Custom Field ID The ID of the custom field to update or clear when the edit type involves custom fields.
Custom Field Value The new value to set for the custom field when the edit type is 'Set Custom Field'. For multi-value fields, a JSON array can be supplied.
Custom Field Operation The operation to perform on multi-value custom fields, such as replace, add, or remove values.
Search Query (s_query JSON) An advanced filtering query object in JSON format that identifies the leads or contacts to act on. This query determines which records the bulk edit will apply to.
Additional Fields Optional additional settings for the bulk edit action, including whether to send a notification email when done, limit the number of records processed, and sorting specifications.

Output

JSON

  • id - The unique identifier of the bulk edit action or affected records.
  • type - The type of bulk edit performed, e.g., set_lead_status, set_custom_field, or clear_custom_field.
  • lead_status_id - The ID of the lead status assigned if the edit type is 'Set Lead Status'.
  • custom_field_id - The ID of the custom field edited if applicable.
  • custom_field_value - The value set for the custom field if applicable.
  • custom_field_operation - The operation performed on the custom field if applicable.
  • s_query - The advanced filtering query used to select records for the bulk edit.
  • send_done_email - Indicates if a notification email will be sent when the bulk action completes.
  • results_limit - The maximum number of records processed in the bulk edit.
  • sort - The sorting criteria applied to the records before editing.

Dependencies

  • Close CRM API
  • an API key credential for authentication

Troubleshooting

  • Ensure the Search Query (s_query) JSON is valid and correctly formatted to avoid JSON parsing errors.
  • Verify that required fields like Lead Status ID or Custom Field ID are provided when their respective edit types are selected.
  • If the bulk edit does not affect any records, check that the filtering query matches existing records.
  • Errors related to missing parameters will indicate which required input is missing; provide all mandatory inputs to resolve.

Links

Discussion