Update a campaign
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 campaign
Body
The updated name of the campaign. Can be omitted
The updated steps of the campaign. Can be omitted
The updated segment of the campaign. Can be omitted
The updated enrolled customer IDs of the campaign. Can be omitted
The email address used to send emails in the campaign. Will be the ID of an email-like object
The phone number used to send SMS messages in the campaign. Will be the ID of a phone number-like object
The scheduled time of the campaign in ISO 8601 format
Response
The ID of the campaign
The name of the campaign
The customers enrolled in the campaign
The segment attached to the campaign
The steps of the campaign
The email address used to send emails in the campaign. Will be the ID of an email-like object
The phone number used to send SMS messages in the campaign. Will be the ID of a phone number-like object
The status of the campaign. One of "draft", "scheduled", "started", or "stopped"
The time when the campaign is scheduled to start in ISO 8601 format
The statistics of the campaign. Includes information about the number of customers enrolled and their status in the campaign
The number of message segments actually used by the campaign
The number of message segments estimated to be used by the campaign