Skip to main content
POST
/
email_blasts
/
{id}
Update an email blast
curl --request POST \
  --url https://api.pocketflows.com/email_blasts/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "segment": "<string>",
  "enrolled_customers": [
    "<string>"
  ],
  "excluded_customers": [
    "<string>"
  ],
  "email_address": "<string>",
  "scheduled_at": "<string>",
  "email_template": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "email_template": "<string>",
  "one_off_email_template": "<string>",
  "subject": "<string>",
  "template_json": "<any>",
  "enrolled_customers": [
    "<string>"
  ],
  "excluded_customers": [
    "<string>"
  ],
  "segment": "<string>",
  "email_address": "<string>",
  "status": "<string>",
  "scheduled_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

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 email blast

Body

application/json
​
name
string

The updated name of the email blast. Can be omitted

​
segment
string | null

The updated segment of the email blast. Can be omitted

​
enrolled_customers
string[]

The updated enrolled customer IDs of the email blast. Can be omitted

​
excluded_customers
string[]

The updated excluded customer IDs of the email blast

​
email_address
string | null

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

​
scheduled_at
string | null

The scheduled time of the email blast in ISO 8601 format

​
email_template
string | null

The ID of the email template to use for the email blast

Response

200 - application/json

The updated EmailBlast object

​
id
string
required

The ID of the email blast

​
name
string
required

The name of the email blast

​
email_template
string | null
required

The email template associated with the email blast. If this is not null, one_off_email_template will be null

​
one_off_email_template
string | null
required

The one-off email template associated with the email blast. If this is not null, email_template will be null

​
subject
string | null
required

The manually set subject of the email blast

​
template_json
any
required

The template JSON of the email blast

​
enrolled_customers
required

The customers enrolled in the email blast

​
excluded_customers
required

The customers excluded from the email blast

​
segment
string | null
required

The segment attached to the email blast

​
email_address
string | null
required

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

​
status
string
required

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

​
scheduled_at
string | null
required

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

⌘I