Close CRM icon

Close CRM

Consume Close CRM API

Actions83

Bulk Action (Automation & Bulk Actions) → List Bulk Emails

AI-generated

Overview

This node interacts with the Close CRM API to perform bulk actions related to emails. Specifically, the 'List Bulk Emails' operation retrieves a list of bulk email actions that have been executed or are in progress. It supports fetching either all results or a limited number based on user input. This operation is useful for scenarios where users need to monitor or analyze bulk email campaigns sent through Close CRM, such as tracking email templates used, email account IDs, and contact preferences.

Use Case Examples

  1. A marketing team wants to retrieve all bulk email campaigns sent in the last month to analyze their performance.
  2. A sales manager needs to list the latest 50 bulk email actions to review the outreach efforts to potential leads.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit. When true, all bulk email records are fetched; when false, only a limited number is returned.
Limit The maximum number of bulk email results to return when 'Return All' is set to false. Must be at least 1.

Output

JSON

  • id - Unique identifier of the bulk email action.
  • template_id - ID of the email template used in the bulk email.
  • email_account_id - ID of the email account from which the bulk email was sent.
  • contact_preference - Contact preference setting for the bulk email recipients.
  • s_query - Search query used to filter the bulk email recipients.
  • send_done_email - Flag indicating whether a notification email is sent after the bulk action is completed.
  • results_limit - Limit on the number of results processed in the bulk action.
  • sort - Sorting criteria applied to the bulk email results.

Dependencies

  • Close CRM API key credential

Troubleshooting

  • Ensure the Close CRM API key credential is correctly configured and has the necessary permissions to access bulk email actions.
  • If the node returns an error about missing parameters, verify that required fields like Template ID and Email Account ID are provided when creating bulk emails.
  • For large datasets, if the node times out or fails, try enabling 'Return All' to paginate through results or increase the limit cautiously.

Links

Discussion