Skip to main content
PATCH
/
v1
/
emails
/
{emailId}
Edit an email design
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\"."
}
'
import requests

url = "https://brew.new/api/v1/emails/{emailId}"

payload = { "prompt": "Tighten the headline and replace the CTA copy with \"Get started today\"." }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt: 'Tighten the headline and replace the CTA copy with "Get started today".'
  })
};

fetch('https://brew.new/api/v1/emails/{emailId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brew.new/api/v1/emails/{emailId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'prompt' => 'Tighten the headline and replace the CTA copy with "Get started today".'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://brew.new/api/v1/emails/{emailId}"

	payload := strings.NewReader("{\n  \"prompt\": \"Tighten the headline and replace the CTA copy with \\\"Get started today\\\".\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://brew.new/api/v1/emails/{emailId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"Tighten the headline and replace the CTA copy with \\\"Get started today\\\".\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/emails/{emailId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"Tighten the headline and replace the CTA copy with \\\"Get started today\\\".\"\n}"

response = http.request(request)
puts response.read_body
{
  "emailId": "eml_2SmZOWV3ZQ7W5x6g3m4p",
  "emailVersionId": "emv_2SmZOWV3ZQ7W5x6g3m4p_v1",
  "html": "<!DOCTYPE html><html><body>Welcome to Brew.</body></html>",
  "previewImage": "https://storage.example.com/emails/eml_2SmZOWV3ZQ7W5x6g3m4p.png"
}

Authorizations

​
Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

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

A natural-language prompt edit, with an optional emailVersionId source pin and optional contentUrls. Identity lives on the path.

​
prompt
string
required
Minimum string length: 1
​
emailVersionId
string
Required string length: 1 - 64
​
contentUrls
string<uri>[]
Maximum array length: 8

Response

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).

​
emailId
string
required
Minimum string length: 1
​
emailVersionId
string
required
Minimum string length: 1
​
html
string
required
​
previewImage
string<uri>