Skip to main content
POST

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
​
X-Brand-Id
string

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.

Required string length: 1 - 64

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

Optional exact source-version pin. Omit the body or send an empty object to clone latest.

​
emailVersionId
string

Exact source version to clone (from list_email_designs with include: ["versions"]). Omit to clone the current latest version.

Required string length: 1 - 64
​
targetGroupId
string

Existing canvas group id (grp_…), or ungrouped. Mutually exclusive with targetGroupName.

Required string length: 1 - 64
​
targetGroupName
string

Resolve-or-create a group by this name. Mutually exclusive with targetGroupId.

Required string length: 1 - 60

Response

Exact clone created. The response carries the clone’s new ids plus the unchanged rendered HTML and preview.

​
emailId
string
required
Minimum string length: 1
​
emailVersionId
string
required
Minimum string length: 1
​
html
string
required
​
group
object | null
required
​
previewImage
string<uri>
​
subjectLine
string