Skip to main content
PATCH
/
v1
/
emails
/
{emailId}
Edit Email
curl --request PATCH \
  --url https://brew.new/api/v1/emails/{emailId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "Tighten the headline and replace the CTA copy with \"Get started today\"."
}
'
{ "emailId": "email_2SmZOWV3ZQ7W5x6g3m4p", "emailHtml": "<!DOCTYPE html><html><body>Welcome to Brew.</body></html>", "emailPng": "https://storage.example.com/emails/email_2SmZOWV3ZQ7W5x6g3m4p.png" }

Documentation Index

Fetch the complete documentation index at: https://docs.brew.new/llms.txt

Use this file to discover all available pages before exploring further.

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

The id of the email to edit. The email must belong to the same brand the API key is scoped to; cross-brand ids surface as 404 to avoid leaking existence.

Body

application/json

Edit instruction and optional fresh content URL. The brand is resolved from the API key and the emailId is on the URL — neither is accepted in the body.

​
prompt
string
required
Minimum string length: 1
​
contentUrl
string<uri>

Response

Updated email artifact (a new version: "latest" row was written) or a text response if the agent returned prose without JSX.

​
emailId
string
required
Minimum string length: 1
​
emailHtml
string
required
​
emailPng
string<uri>