v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Emails

Export a design to an ESP

Export a finished email DESIGN to a connected third-party ESP (Klaviyo, Mailchimp, HubSpot, Braze, Iterable, Postmark, OneSignal, SendGrid, Mailgun) as a reusable TEMPLATE. This is NOT a Brew send — it creates a template in the destination platform and does NOT deliver to recipients, and is unrelated to Brew sending domains or audiences. The provider must already be connected for the brand (connect ESPs in the Brew app). The exported HTML is automatically made ESP-portable. Pass dry_run: true to validate the design, brand ownership, and ESP connection without creating a template. Free (no credits).

post/v1/emails/{emailId}/export

Path parameters

emailIdstring required

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

Example:eml_2SmZOWV3ZQ7W5x6g3m4p

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

Headers

Idempotency-Keystring

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

Request body

provider'braze' | 'hubspot' | 'klaviyo' | 'mailchimp' | 'iterable' | 'postmark' | 'onesignal' | 'mailgun' | 'sendgrid' required

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

templateNamestring

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

dry_runboolean

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.

emailIdstring required
provider'braze' | 'hubspot' | 'klaviyo' | 'mailchimp' | 'iterable' | 'postmark' | 'onesignal' | 'mailgun' | 'sendgrid' required
providerNamestring required
templateNamestring required
templateIdstring
dryRunboolean required