Skip to main content
POST
/
emails
Send an email to the store's people
curl --request POST \
  --url https://api.salesive.com/api/v1/emails \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "audience": "customers",
  "subject": "Weekend sale starts now",
  "title": "20% off everything",
  "message": "For this weekend only, use code WEEKEND20 at checkout.",
  "actionText": "Shop now",
  "actionUrl": "https://mystore.salesive.com"
}
'
{
  "status": 200,
  "success": true,
  "message": "Email queued for delivery",
  "data": {
    "audience": "customers",
    "recipients": 342
  }
}
Sends a templated email to one of the store’s own audiences (merchant, customers, or subscribers). Recipients are resolved server-side — an app can never email an arbitrary address. Customer and subscriber blasts are capped at 1000 recipients; rate limited to 10 send requests per hour per installation.

Authorizations

​
Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Body

application/json
​
audience
enum<string>
required

Who to send to. One of: "merchant" (the store owner), "customers" (the store's active customers), or "subscribers" (the store's newsletter subscribers).

Available options:
merchant,
customers,
subscribers
​
subject
string
required

Email subject line.

​
title
string
required

Headline rendered at the top of the email body.

​
message
string
required

Main body text of the email.

​
actionText
string

Optional call-to-action button label. Pair with actionUrl.

​
actionUrl
string

Optional URL the call-to-action button links to. Pair with actionText.

Response

The email was queued for the resolved audience.

Standard Salesive response envelope. The operation-specific payload is carried in data.

​
status
integer
required

HTTP status code, echoed in the body.

​
success
boolean
required

Whether the request succeeded.

​
message
string
required

Human-readable result message.

​
data
object