Sign in

v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Emails

Import a Figma frame

Deterministically converts one selected Figma frame into a new editable Brew email design. No model runs and no credits are charged.

figmaUrl must be a Figma frame link containing node-id. The API-key brand must already have Figma connected in Brew Integrations, and that connected account must be able to read the file.

Set format to jsx (default) for React Email JSX or html for rendered email HTML. The requested representation is returned in content; the persisted design is identified by emailId and emailVersionId.

post/v1/emails/figma

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

figmaUrlstring uri required

A figma.com design, file, or prototype URL for a specific frame. The URL must include a node-id query parameter.

titlestring

Optional design title; defaults to the Figma frame name.

format'jsx' | 'html'

Source representation returned in content: React Email JSX by default, or rendered email-safe HTML.

Response

The converted design was persisted and the requested source representation is returned in content.

emailIdstring required
emailVersionIdstring required
titlestring required
format'jsx' | 'html' required
contentstring required
warningCountinteger required
exportedNodeCountinteger required
previewImagestring uri