Close CRM icon

Close CRM

Consume Close CRM API

Actions83

Bulk Action (Automation & Bulk Actions) → Bulk Sequence Subscription

AI-generated

Overview

This node operation performs bulk sequence subscription actions in Close CRM. It allows users to subscribe, pause, resume, or resume finished sequence subscriptions for multiple contacts based on an advanced filtering query. This is useful for automating mass enrollment or management of contacts in email or automation sequences, such as subscribing a large group of contacts to a marketing sequence or pausing all subscriptions matching certain criteria.

Use Case Examples

  1. Subscribe matched contacts to a specific sequence using a sender's email account and name.
  2. Pause all sequence subscriptions that match a given search query.
  3. Resume sequence subscriptions that were previously paused or finished for a filtered set of contacts.

Properties

Name Meaning
Action Type The bulk subscription action to perform, such as subscribe, pause, resume, or resume finished.
Sequence ID Required when subscribing: the ID of the sequence to enroll matched contacts in.
Sender Account ID Required when subscribing: the email account ID used to send the sequence.
Sender Name Required when subscribing: the display name of the sender.
Sender Email Required when subscribing: the email address of the sender.
Contact Preference Whether to use the primary lead email or the first email per contact when subscribing.
Search Query (s_query JSON) Advanced filtering query object identifying the leads/contacts to act on, using Close CRM's advanced filtering syntax.
Additional Fields Optional additional parameters such as whether to send a notification email when the bulk action is finished, limit on the number of records to process, and sorting specifications.

Output

JSON

  • id - The ID of the created or affected bulk sequence subscription action.
  • action_type - The type of bulk action performed (subscribe, pause, resume, resume_finished).
  • sequence_id - The ID of the sequence involved in the bulk action (if applicable).
  • sender_account_id - The email account ID used for sending the sequence (if applicable).
  • sender_name - The display name of the sender (if applicable).
  • sender_email - The email address of the sender (if applicable).
  • contact_preference - The contact email preference used for the action.
  • s_query - The advanced filtering query object used to identify contacts/leads for the bulk action.
  • send_done_email - Indicates if a notification email will be sent when the bulk action finishes.
  • results_limit - The 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 all required fields for the 'subscribe' action (Sequence ID, Sender Account ID, Sender Name, Sender Email) are provided; missing these will cause errors.
  • The 'Search Query (s_query JSON)' must be valid JSON; invalid JSON will cause parsing errors.
  • If the bulk action fails, check API limits and permissions for the Close CRM API key used.
  • Errors related to missing Bulk Action ID when retrieving or managing existing bulk actions indicate that the ID parameter was not provided.

Links

Discussion