Update Email Campaign

put

https://api.whippy.co/v1/campaigns/email/{id}

Updates an email campaign. The campaign type is set to email. from is the channel's
sending_email_address and is required when the campaign is not already email. A non-draft
email campaign needs subject, sender_name, and sender_email. reply_to is optional.

The campaign must have finished preprocessing and be draft, scheduled, recurring, or
recurring_paused. A scheduled campaign accepts title, schedule_at, status, and
automation_templates. A draft or recurring campaign also accepts the message, from,
audience filters, and recurring_settings. draft to scheduled sends once at schedule_at.
draft to recurring starts the series.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Campaign ID

Body Params

Update Email Campaign Params

Request schema for updating a email campaign at PUT /v1/campaigns/email/:id.

The campaign type is set to email. A campaign that is not already email must include from. A non-draft email campaign needs subject, sender_name, and sender_email. reply_to is optional.

A scheduled campaign accepts title, schedule_at, status, and automation_templates.
A draft, recurring, or recurring_paused campaign also accepts the message, from, the audience
filters, and recurring_settings. recurring_settings is merged with the stored schedule.

attachments

array of strings

List of attachment URLs. Accepted for a draft or recurring campaign.

attachments

automation_templates

array of uuids

length ≤ 50

List of automation template IDs. At most 50.

automation_templates

body

string

Campaign message body. Email has no length limit here.

excluded_audience

array of objects

Whippy Query filter items for the contacts to exclude. Optional. When omitted, the default
campaign exclusions for the channel are applied.

excluded_audience

from

string

The email channel's sending_email_address. Required when this request changes the campaign to email.

included_audience

array of objects

Whippy Query filter items for the contacts to include. Optional for a draft. Required when
status is scheduled or recurring.

included_audience

recurring_settings

object | null

Schedule for a recurring SMS series.

cron_expression, timezone, and start_date are required when this object is present.
end_date is optional. Required on create when status is recurring. Optional on a draft.

On update the object is merged with the stored schedule. Omit a field to keep its stored
value. Send end_date as null to clear a stored end date.

parent_campaign_id is set by the server on a scheduled occurrence and is null on the
series parent. A value sent by the caller is ignored.

reply_to

string | null

Reply-to address. Optional.

schedule_at

date-time

Scheduling time for the campaign. Requires ISO 8601 format.

sender_email

string | null

Email address shown as the sender. Required when status is scheduled or recurring.

sender_name

string | null

Name shown as the sender. Required when status is scheduled or recurring.

status

string

enum

draft or scheduled for a one-time campaign. recurring starts or restarts a series.
recurring_paused or recurring_cancelled stops one.

Allowed:

subject

string | null

Email subject. Optional on a draft. Required when status is scheduled or recurring.

title

string

Campaign title

Responses

Callback

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Campaign

400Bad Request

401Not Authenticated

422Unprocessable Content