Skip to main content
PATCH
/
v1
/
email
/
drafts
/
{draft_id}
Edit a draft (only allowed while status='draft')
curl --request PATCH \
  --url https://api-sandbox.featherhq.com/v1/email/drafts/{draft_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "subject": "<string>",
  "body_html": "<string>",
  "body_text": "<string>",
  "to": [
    {
      "address": "<string>",
      "name": "<string>"
    }
  ],
  "cc": [
    {
      "address": "<string>",
      "name": "<string>"
    }
  ],
  "bcc": [
    {
      "address": "<string>",
      "name": "<string>"
    }
  ],
  "reply_to": [
    {
      "address": "<string>",
      "name": "<string>"
    }
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "in_reply_to_turn_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subject": "<string>",
  "body_html": "<string>",
  "body_text": "<string>",
  "to": [
    {
      "address": "<string>",
      "name": "<string>"
    }
  ],
  "cc": [
    {
      "address": "<string>",
      "name": "<string>"
    }
  ],
  "bcc": [
    {
      "address": "<string>",
      "name": "<string>"
    }
  ],
  "reply_to": [
    {
      "address": "<string>",
      "name": "<string>"
    }
  ],
  "approved_by_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "approved_at": "2023-11-07T05:31:56Z",
  "sent_turn_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "evidence_snapshot": {},
  "auto_send_reason": "<string>",
  "discarded_by_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "discarded_at": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Path Parameters

draft_id
string<uuid>
required

Body

application/json

Partial update — only fields explicitly set are touched. None on an optional list is "no change"; passing an empty list clears that recipient list.

subject
string | null
Required string length: 1 - 998
body_html
string | null
Minimum string length: 1
body_text
string | null
to
EmailAddress · object[] | null
cc
EmailAddress · object[] | null
bcc
EmailAddress · object[] | null
reply_to
EmailAddress · object[] | null

Response

Successful Response

One draft row, including the v1 audit snapshot when present.

evidence_snapshot is exposed as the raw dict from metadata_["evidence_snapshot"] — the shape is captured by EVIDENCE_SCHEMA_VERSION so consumers can branch on it.

id
string<uuid>
required
organization_id
string<uuid>
required
session_id
string<uuid>
required
account_id
string<uuid>
required
agent_id
string<uuid> | null
required
in_reply_to_turn_id
string<uuid> | null
required
mode
enum<string>
required
Available options:
human_only,
copilot
status
enum<string>
required
Available options:
draft,
submitted,
approved,
sending,
sent,
failed,
discarded
approval_state
enum<string>
required
Available options:
unsubmitted,
pending,
approved,
rejected,
auto_approved
subject
string
required
body_html
string
required
body_text
string | null
required
to
EmailAddress · object[]
required
cc
EmailAddress · object[]
required
bcc
EmailAddress · object[]
required
reply_to
EmailAddress · object[]
required
approved_by_member_id
string<uuid> | null
required
approved_at
string<date-time> | null
required
sent_turn_id
string<uuid> | null
required
evidence_snapshot
Evidence Snapshot · object
required
auto_send_reason
string | null
required
discarded_by_member_id
string<uuid> | null
required
discarded_at
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required