Skip to main content
POST
Export a design to an ESP

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
provider
enum<string>
required

The connected ESP to export the design to as a template.

Available options:
braze,
hubspot,
klaviyo,
mailchimp,
iterable,
postmark,
onesignal,
mailgun,
sendgrid
templateName
string

Template name in the ESP. Defaults to the email title.

Required string length: 1 - 100
dry_run
boolean

Validate the design, brand ownership, and ESP connection without creating a template.

Response

Dry run — the design + ESP connection were validated without creating a template.

emailId
string
required
provider
enum<string>
required
Available options:
braze,
hubspot,
klaviyo,
mailchimp,
iterable,
postmark,
onesignal,
mailgun,
sendgrid
providerName
string
required
templateName
string
required
dryRun
boolean
required
templateId
string