Skip to main content
PATCH
Update email metadata

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Path Parameters

emailId
string<uuid>
required

Email ID.

Body

application/json
name
string

Internal name.

Required string length: 1 - 200
subject
string

Subject line.

Required string length: 1 - 998
preview_text
string | null

Preheader text.

Maximum string length: 200
from_name
string | null

Sender display name.

Maximum string length: 120
from_address
string | null

Sender address.

reply_to_email
string | null

Reply-to address.

Response

Updated email.

Full email object.

email_id
string<uuid>
required

Email ID.

name
string
required

Internal name (never shown to recipients).

status
enum<string>
required

Lifecycle state.

Available options:
draft,
approved
current_version
integer
required

Latest content version number.

subject
string | null

Subject line.

preview_text
string | null

Preheader text.

from_name
string | null

Sender display name.

from_address
string | null

Sender address. Sending requires a verified domain.

reply_to_email
string | null

Reply-to address.

approved_version
integer | null

Version that is approved, or null.

number_of_iterations
integer

Number of content versions (equals current_version).

plain_text_overridden
boolean

Whether plain text has been manually overridden.

plain_text_overridden_at
string<date-time> | null

When the plain-text override was set.

plain_text_stale_after_html_iteration
boolean

True when HTML changed after a plain-text override, so the override may be stale.

created_at
string<date-time>

Creation time.

updated_at
string<date-time>

Last update.

created_by_name
string

Who created the email (API key name or user).

latest_generation_status
enum<string>

Status of the most recent AI generation, when one exists.

Available options:
generating,
completed,
failed
content_path
string

API path to fetch the latest HTML, e.g. /v1/emails/{emailId}/content.

plain_text_path
string

API path to fetch the plain-text rendition.