Send Bulk Emails

post

https://api.campaignrefinery.com/api/send/bulk_email

Send bulk emails to multiple contacts using raw HTML content. Supports two recipient modes: by email addresses or by contact UUIDs.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

emails

array of strings

length ≤ 500

List of recipient email addresses (use this OR contact UUIDs). Maximum 500 emails per request.

emails

contact_ids

array of strings

length ≤ 500

List of recipient contact UUIDs (use this OR emails). Maximum 500 contacts per request.

contact_ids

subject

string

required

Email subject line (required)

content

string

required

HTML email content (required)

domain_id

string

required

Domain settings for Managed users, Sending Domains for BYO users, copy the uuid (required)

footer_id

string

required

Footer template ID (required)

from_name

string

Custom sender name to display in the email From field. If not provided, the default sender name from your domain settings will be used.

from_email

string

Custom sender email address. Must use the same domain as your verified sending domain (e.g., if your domain is example.com, from_email must be [email protected]). If not provided, the default sender email from your domain settings will be used.

replyto_name

string

Custom reply-to name. If not provided, replies will use the default settings.

replyto_email

string

Custom reply-to email address. If not provided, replies will use the default settings.

preview_text

string

length ≤ 150

Preview text shown in email clients before opening the email (max 150 characters).

custom_params

object

Custom metadata key-value pairs for tracking the send request (max 10 keys, max 1024 characters per value).

suppression_list_ids

array of strings

List of suppression list UUIDs to check against

suppression_list_ids

to_name

string

Custom recipient display name for the To field. If not provided, the contact's name from their record will be used.

custom_headers

object

Custom X- headers to include in the email (max 10). All keys must start with 'X-' and values must be strings (max 998 characters each).

attachments

array of objects

length ≤ 5

File attachments to include in the email (max 5). Individual attachments max 10MB, total max 25MB.

attachments

callback_url

uri

length ≤ 2048

URL to be called once the bulk email job is completed.

Responses

200Bulk email job dispatched successfully

403Invalid or inactive API key

422Validation error