OpenAPI 3.1.0MIT2026-08-15105151330.5 KB

5ed4a5a287b5

Campaigns

Create Campaign

Create a new email campaign from a generated email. Use emailId for the exact generated email, especially series slots. Requires API key with campaign:write.

post/v1/campaigns

Request body

projectIdstring required

Project ID

namestring required

Campaign name

conversationIdstring required

Conversation ID that owns the generated email

emailIdstring

Generated email ID from result.emails[].emailId. Recommended for series slots.

subjectstring

Email subject (auto-populated from conversation if omitted)

preheaderTextstring

Preheader text

fromstring email required

Sender email address

fromNamestring required

Sender display name

replyTostring email

Reply-to address

recipientType'audience' | 'tag' required

Send to a segment (audience) or tag

recipientIdstring required

Segment or tag ID

topicIdstring

Topic ID for preference filtering

providerType'ses' | 'resend' | 'sendgrid' | 'mailgun' | 'migma'

Email provider (default: migma)

variablesobject

Template variables

Response

Campaign created

successboolean required

errorstring nullable