API Reference
API ReferenceSubmit a Ticket
Start typing to search…

Send Single Email

post
https://api.campaignrefinery.com/api/send/single_email

Send a single email to a contact using raw HTML content. Supports two recipient modes: by email address or by contact UUID.

Body Params
string

Recipient's email address (required if contact_id not provided)

string

Recipient's contact UUID (required if email not provided)

string
required

Email subject line (required)

string
required

HTML email content (required)

string
required

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

string
required

Footer template ID (required)

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.

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.

string

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

string

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

string
length ≤ 150

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

custom_params
object

Custom metadata key-value pairs. Returned in webhook notifications (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
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
Responses

Updated 3 months ago

Language
Credentials
Bearer
Request
Response 
 Choose an example:
application/json
Updated 3 months ago