Skip to main content
POST
Personalize Campaign Email

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Internal-Api-Key
string | null

Path Parameters

campaign_id
string<uuid>
required

Body

application/json

Request to personalize email content for a campaign lead.

campaign_lead_id
string<uuid>
required

The campaign lead ID

job_id
string<uuid>
required

The outbound job ID

step_index
integer
required

The step index in the campaign

Required range: x >= 0
variant_label
string
required

The variant label for A/B testing

sender_profile_id
string<uuid>
required

The sender profile ID to use

Response

Successful Response

Response containing personalized email content.

job_id
string<uuid>
required

The outbound job ID

campaign_lead_id
string<uuid>
required

The campaign lead ID

personalized_subject
string
required

Personalized email subject

personalized_body
string
required

Personalized email body (HTML)

sender_email
string
required

Sender email from profile

recipient_email
string
required

Recipient email address

credits_consumed
integer
required

Credits consumed for personalization