Skip to main content
POST
/
businesses
/
{id}
/
email_blasts
Create an email blast
curl --request POST \
  --url https://api.pocketflows.com/businesses/{id}/email_blasts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email_template": "<string>",
  "enrolled_customers": [
    "<string>"
  ],
  "excluded_customers": [
    "<string>"
  ],
  "email_address": "<string>",
  "segment": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "email_template": "<string>",
  "status": "<string>",
  "scheduled_at": "<string>",
  "segment": "<string>",
  "email_address": "<string>",
  "enrolled_customers": [
    "<string>"
  ],
  "excluded_customers": [
    "<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 business

Body

application/json
​
name
string
required

The name of the email blast

​
email_template
required

The ID of the email template or the content of the email template to create

​
enrolled_customers
string[]

The ID of the customers enrolled in the email blast

​
excluded_customers
string[]

The ID of the customers excluded from the email blast

​
email_address
string | null

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

​
segment
string | null

The ID of the segment to attach to the email blast

Response

200 - application/json

The created 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

​
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

​
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

​
enrolled_customers
string[]

The customers enrolled in the email blast

​
excluded_customers
string[]

The customers excluded from the email blast