Close CRM icon

Close CRM

Consume Close CRM API

Bulk Action (Automation & Bulk Actions) → Get Bulk Edit

AI-generated

Overview

This node operation fetches details of a specific Bulk Edit action within the Close CRM platform. It is useful for retrieving information about a bulk edit operation that has been previously created, identified by its Bulk Action ID. This can help users monitor or audit bulk changes applied to leads or other entities in Close CRM.

Use Case Examples

  1. Retrieve details of a Bulk Edit action by providing its Bulk Action ID to review the changes made in a bulk update operation.
  2. Use this operation to fetch metadata and status of a Bulk Edit to verify its execution or results.

Properties

Name Meaning
Bulk Action ID The ID of the bulk action to fetch, used to identify the specific Bulk Edit action to retrieve.

Output

JSON

  • id - The unique identifier of the bulk edit action.
  • type - The type of bulk action, e.g., 'edit'.
  • lead_status_id - The lead status ID if the bulk edit involves setting lead status.
  • custom_field_id - The custom field ID if the bulk edit involves modifying a custom field.
  • custom_field_value - The value set for the custom field in the bulk edit.
  • custom_field_operation - The operation performed on the custom field, e.g., 'replace'.
  • s_query - The search query used to select the leads or records affected by the bulk edit.
  • send_done_email - Flag indicating whether a notification email is sent upon completion.
  • results_limit - The limit on the number of results processed or returned.
  • sort - Sorting criteria applied to the bulk edit results.

Dependencies

  • Close CRM API authentication

Troubleshooting

  • Ensure the Bulk Action ID is provided and valid; missing or incorrect IDs will cause errors.
  • Check API credentials and permissions to access bulk action details in Close CRM.
  • If the bulk edit action does not exist or has been deleted, the node will return an error.

Discussion