Sign in
Email blasts

Create an email blast

post/businesses/{id}/email_blasts

Path parameters

idstring required

The ID of the business

Request body

namestring required

The name of the email blast

enrolled_customersstring[]

The ID of the customers enrolled in the email blast

excluded_customersstring[]

The ID of the customers excluded from the email blast

email_addressstring nullable

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

segmentstring nullable

The ID of the segment to attach to the email blast

Response

The created EmailBlast object

idstring required

The ID of the email blast

namestring required

The name of the email blast

created_atstring required

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

email_templatestring nullable required

The email template associated with the email blast

statusstring required

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

scheduled_atstring nullable required

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

segmentstring nullable required

The segment attached to the email blast

email_addressstring nullable required

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

enrolled_customersstring[]

The customers enrolled in the email blast

excluded_customersstring[]

The customers excluded from the email blast

attributed_revenuestring nullable required

The revenue attributed to the email blast

Changes

No recorded changes to this endpoint across all 1 revision of this API.