Edit an email design
Applies a natural-language prompt edit (optionally a emailVersionId source pin + contentUrls) to an existing design: the Brew email agent edits the design’s current latest version (or the pinned version) and writes a new version: "latest" row on the same emailId (the previous head is demoted to a numeric historical version).
USAGE-metered — the agent’s actual token spend is charged. Returns the generated-email shape with the new emailVersionId.
Authorizations
Send your Brew API key as Authorization: Bearer brew_xxx.
Headers
The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.
1 - 64Path Parameters
Design id returned by POST /v1/emails and listed by GET /v1/emails.
1 - 64"eml_2SmZOWV3ZQ7W5x6g3m4p"
Body
A natural-language prompt edit, with an optional emailVersionId source pin and optional contentUrls. Identity lives on the path.
The edit to make, in plain language — e.g. "swap the hero for the spring campaign image and tighten the CTA copy". Scoped edits beat full rewrites.
1Pin the edit to a specific source version (from list_email_designs include: ["versions"]). Omit to edit the current latest.
1 - 64Up to 8 URLs whose content grounds the edit (e.g. the product page the new section should describe).
8Response
Updated design (a new latest version row was written) or a text response if the agent returned prose instead of a design. USAGE-metered: the agent’s actual token usage is charged (no fixed price).