Email Templates
- The Email Template object
- GETList all email templates for a business
- POSTCreate an email template
- POSTCreate a new email template using AI
- POSTCopy a project email template into a specific business
- GETRetrieve an email template
- GETPreview an email template
- GETPreview an email template as an image
- POSTUpdate an email template
- DELDelete an email template
Email Template Embeds
Project Email Templates
Business Email Addresses
Project Email Addresses
Emails
SMS Templates
SMS Template Embeds
SMS Messages
Project Phone Numbers
Campaigns
Campaign Embeds
Triggers
List all campaigns
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
The ID of the business
Response
An array of campaigns
The number of message segments actually used by the campaign
The email address used to send emails in the campaign. Will be the ID of an email-like object
The customers enrolled in the campaign
The number of message segments estimated to be used by the campaign
The ID of the campaign
The name of the campaign
The phone number used to send SMS messages in the campaign. Will be the ID of a phone number-like object
The time when the campaign is scheduled to start in ISO 8601 format
The segment attached to the campaign
The statistics of the campaign. Includes information about the number of customers enrolled and their status in the campaign
The number of customers enrolled in the campaign
The number of customers who have finished receiving all the messages in the campaign
The number of customers who have started receiving messages in the campaign
The status of the campaign. One of "draft", "scheduled", "started", or "stopped"
The steps of the campaign
The ID of the email template to use in this step
The step type. Always "email" for this step
email
Optional. The ID of the custom step to use in this step. The type of the custom step must be "email" as well