Sign in
latestOpenAPI 3.1.02026-08-233001841.3 MB

0dcf3303e9d7

bulk_actions.email

Initiate a new bulk email

contact_preference can be set to lead (only email the primary/first contact email of the lead) or contact (email the first contact email of each contact of the lead).

post/bulk_action/email/

Response

Successful response

contact_preference'lead' | 'contact' | 'all' required
created_bystring nullable required
date_createdstring date-time nullable required
date_updatedstring date-time nullable required
email_account_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
senderstring nullable required
sortobject[] required
status'created' | 'loading' | 'processing' | 'done' | 'paused' | 'resuming' | 'error' required
template_idstring nullable required
updated_bystring nullable required