Skip to main content
POST
Schedule an email blast

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The ID of the email blast

Body

application/json
scheduled_at
string
required

The scheduled time of the email blast in ISO 8601 format

Response

200 - application/json

The scheduled EmailBlast object

id
string
required

The ID of the email blast

name
string
required

The name of the email blast

created_at
string
required

The time when the email blast was created in ISO 8601 format

email_template
string | null
required

The email template associated with the email blast

status
string
required

The status of the email blast. One of "draft", "scheduled", "started", or "stopped"

scheduled_at
string | null
required

The time when the email blast is scheduled to start in ISO 8601 format

segment
string | null
required

The segment attached to the email blast

email_address
string | null
required

The email address used to send the email blast. Will be the ID of an email-address-like object

statistics
object
required

The statistics of the email blast including email delivery metrics

attributed_revenue
string | null
required

The revenue attributed to the email blast

enrolled_customers
string[]

The customers enrolled in the email blast

excluded_customers
string[]

The customers excluded from the email blast