Sign in

v1

latestOpenAPI 3.0.02026-07-2612645160.3 KB
email-channel

Create an email campaign

Creates a campaign with a list of recipients. If scheduled_at is omitted, the campaign is dispatched immediately. The email_channel_id must point to a verified channel.

post/api/public/email-campaign

Headers

x-api-keystring required

API key needed to authorize the request

Request body

titlestring required
email_template_idstring uuid required
email_channel_idstring uuid required
scheduled_atstring date-time

Response

idstring required
titlestring required
status'draft' | 'scheduled' | 'sending' | 'sent' | 'failed' required
email_template_idstring required
email_channel_idstring required
scheduled_atstring date-time nullable required
sent_atstring date-time nullable required
total_recipientsnumber required
created_atstring date-time required