Skip to main content
POST
/
v1
/
emails
/
{emailId}
/
client-previews
curl --request POST \
  --url https://brew.new/api/v1/emails/{emailId}/client-previews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "emailId": "eml_welcome",
  "inspectionId": "DdbNga1MdL3N7sO19v5MAmpOKIqFrLg9cgpCIgS4othXJ",
  "status": "partial",
  "previews": [
    {
      "id": "gmailcom-lm_chrcurrent_win10",
      "label": "Gmail (Web)",
      "category": "gmail",
      "os": "Web",
      "dark": false,
      "status": "ready",
      "imageUrl": "https://cdn.brew.new/email-preview/eml_welcome/gmailcom-lm_chrcurrent_win10-abc.png"
    },
    {
      "id": "outlook2021_win11_lm_dt",
      "label": "Outlook 2021 (Windows)",
      "category": "outlook",
      "os": "Windows",
      "dark": false,
      "status": "processing",
      "imageUrl": null
    }
  ],
  "pending": [
    "outlook2021_win11_lm_dt"
  ]
}

Authorizations

​
Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

​
Idempotency-Key
string

Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.

Required string length: 1 - 100

Path Parameters

​
emailId
string
required

Design id returned by POST /v1/emails and listed by GET /v1/emails.

Required string length: 1 - 64
Example:

"eml_2SmZOWV3ZQ7W5x6g3m4p"

Body

application/json
​
clients
string[]

Client ids to render. Omit for a default popular spread of Gmail, Outlook, Apple Mail & iOS. Supported: gmailcom-lm_chrcurrent_win10 = Gmail (Web); gmailcom-dm_chrcurrent_win10 = Gmail (Web, Dark); android16_gmailapp_pixel10_lm = Gmail (Android); android16_gmailapp_pixel10_dm = Gmail (Android, Dark); iphone16gmail_18 = Gmail (iOS); outlook2021_win11_lm_dt = Outlook 2021 (Windows); outlook2021_win11_dm_dt = Outlook 2021 (Windows, Dark); o365_w10_lm_dt = Outlook 365 (Windows); outlookcom-lm_chrcurrent_win10 = Outlook.com (Web); applemail16 = Apple Mail (macOS); applemail16_dm = Apple Mail (macOS, Dark); iphone16_18 = Apple Mail (iOS); iphone16_18_dm = Apple Mail (iOS, Dark); yahoocom-lm_chrcurrent_win10 = Yahoo Mail (Web).

Required array length: 1 - 12 elements
Required string length: 1 - 80

Response

Per-client screenshots. ready clients carry a rehosted imageUrl; clients still rendering are listed in pending with status: "processing".

​
emailId
string
required
​
inspectionId
string
required
​
status
enum<string>
required
Available options:
ready,
partial
​
previews
object[]
required
​
pending
string[]
required