POST
/
campaigns
/
{id}

Authorizations

Authorization
string
headerrequired

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 campaign

Body

application/json
name
string

The updated name of the campaign. Can be omitted

steps
object[]

The updated steps of the campaign. Can be omitted

enrolled_customers
string[]

The updated enrolled customer IDs of the campaign. Can be omitted

email_address
string | null

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

phone_number
string | null

The phone number used to send SMS messages in the campaign. Will be the ID of a phone number-like object

scheduled_at
string | null

The scheduled time of the campaign in ISO 8601 format

Response

200 - application/json
id
string
required

The ID of the campaign

name
string
required

The name of the campaign

enrolled_customers
required

The customers enrolled in the campaign

steps
object[]
required

The steps of the campaign

email_address
string | null
required

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

phone_number
string | null
required

The phone number used to send SMS messages in the campaign. Will be the ID of a phone number-like object

status
string
required

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

scheduled_at
string | null
required

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

statistics
object
required

The statistics of the campaign. Includes information about the number of customers enrolled and their status in the campaign

Preview a campaign as an imageStart a campaign