Campaigns
The Campaign object
Campaigns
The Campaign object
id
string
requiredThe ID of the campaign
name
string
requiredThe name of the campaign
enrolled_customers
required
The customers enrolled in the campaign
segment
string | null
requiredThe segment attached to the campaign
steps
object[]
requiredThe steps of the campaign
email_address
string | null
requiredThe email address used to send emails in the campaign. Will be the ID of an email-like object
phone_number
string | null
requiredThe phone number used to send SMS messages in the campaign. Will be the ID of a phone number-like object
status
string
requiredThe status of the campaign. One of "draft", "scheduled", "started", or "stopped"
scheduled_at
string | null
requiredThe time when the campaign is scheduled to start in ISO 8601 format
statistics
object
requiredThe statistics of the campaign. Includes information about the number of customers enrolled and their status in the campaign
consumed_message_segments
object
requiredThe number of message segments actually used by the campaign
estimated_message_segments
object
requiredThe number of message segments estimated to be used by the campaign