Close CRM icon

Close CRM

Consume Close CRM API

Bulk Action (Automation & Bulk Actions) → Send Bulk Email

AI-generated

Overview

This node operation sends bulk emails using a specified email template and email account within the Close CRM platform. It allows users to target leads or contacts based on an advanced filtering query (s_query JSON) and customize the sending preferences such as contact preference, sender email override, and limits on the number of processed records. This operation is useful for automating mass email campaigns to segmented audiences in a CRM system.

Use Case Examples

  1. Sending a promotional email to all leads with a specific status using a predefined email template.
  2. Sending a bulk notification email to contacts filtered by custom criteria, with an option to receive a notification email once the bulk action is completed.

Properties

Name Meaning
Template ID ID of the email template to send, required to specify which email content to use.
Email Account ID ID of the email account used to send the emails, required to specify the sending account.
Contact Preference Determines whether to use the primary contact email per lead or the first email per contact when sending emails.
Search Query (s_query JSON) Advanced filtering query object identifying the leads or contacts to act on, allowing precise targeting based on Close CRM's advanced filtering capabilities.
Additional Fields Optional additional settings for the bulk email action, including whether to send a notification email when done, limit on the number of records processed, sorting specifications, and sender email override.

Output

JSON

  • id - ID of the created bulk email action.
  • template_id - ID of the email template used.
  • email_account_id - ID of the email account used to send the emails.
  • contact_preference - Contact preference setting used for sending emails.
  • s_query - The advanced filtering query object used to select leads or contacts.
  • sender - Sender email address override if specified.
  • send_done_email - Indicates if a notification email will be sent when the bulk action is finished.
  • results_limit - Maximum number of records processed in the bulk action.
  • sort - Sorting specifications applied to the bulk action.

Dependencies

  • Close CRM API key credential

Troubleshooting

  • Ensure that both Template ID and Email Account ID are provided; missing these will cause errors.
  • Verify that the s_query JSON is valid and correctly formatted to avoid JSON parsing errors.
  • If the bulk email does not send, check the email account permissions and API credentials.
  • Errors related to missing required parameters will be thrown if mandatory fields are not set.
  • If the node fails but continueOnFail is enabled, error details will be returned in the output for each failed item.

Discussion