Sign in
latestOpenAPI 3.1.02026-08-233001841.3 MB

0dcf3303e9d7

bulk_actions.sequence_subscriptions

Initiate a new bulk sequence subscription

action_type must be one of:

  • subscribe to create a new sequence subscription for contacts that have never received the given sequence.
  • resume to resume any paused sequence subscriptions for the given sequence or all sequences if sequence_id is not provided.
  • resume_finished to resume any finished sequence subscriptions for the given sequence or all sequences if sequence_id is not provided.
  • pause to pause any active sequence subscriptions for the given sequence or all sequences if sequence_id is not provided.

sequence_id, sender_account_id, sender_name, sender_email and contact_preference are required if action_type is subscribe.

contact_preference can be set to:

  • lead to only subscribe the primary/first contact email of the lead.
  • contact to subscribe the primary email of each contact of the lead.
post/bulk_action/sequence_subscription/

Response

Successful response

action_type'subscribe' | 'resume' | 'resume_finished' | 'pause' | 'reassign' required
calls_assigned_tostring[] nullable required
contact_preference'lead' | 'contact' required
created_bystring nullable required
date_createdstring date-time nullable required
date_updatedstring date-time nullable required
from_phone_number_idstring nullable required
idstring required
n_leadsinteger nullable required
n_leads_processedinteger required
n_objectsinteger nullable required
n_objects_processedinteger required
organization_idstring required
querystring nullable required
results_limitinteger nullable required
s_queryobject required
send_done_emailboolean required
sender_account_idstring nullable required
sender_emailstring nullable required
sender_namestring nullable required
sequence_idstring nullable required
sortobject[] required
status'created' | 'loading' | 'processing' | 'done' | 'paused' | 'resuming' | 'error' required
updated_bystring nullable required