Edit a draft (only allowed while status='draft')
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>"
}
]
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/email/drafts/{draft_id}"
payload = {
"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>"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'}]
})
};
fetch('https://api-sandbox.featherhq.com/v1/email/drafts/{draft_id}', 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://api-sandbox.featherhq.com/v1/email/drafts/{draft_id}",
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([
'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>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api-sandbox.featherhq.com/v1/email/drafts/{draft_id}"
payload := strings.NewReader("{\n \"subject\": \"<string>\",\n \"body_html\": \"<string>\",\n \"body_text\": \"<string>\",\n \"to\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"cc\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"reply_to\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api-sandbox.featherhq.com/v1/email/drafts/{draft_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"subject\": \"<string>\",\n \"body_html\": \"<string>\",\n \"body_text\": \"<string>\",\n \"to\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"cc\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"reply_to\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/email/drafts/{draft_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subject\": \"<string>\",\n \"body_html\": \"<string>\",\n \"body_text\": \"<string>\",\n \"to\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"cc\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"reply_to\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"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",
"mode": "human_only",
"status": "draft",
"approval_state": "unsubmitted",
"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"
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Path Parameters
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.
Required string length:
1 - 998Minimum string length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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.
Available options:
human_only, copilot Available options:
draft, submitted, approved, sending, sent, failed, discarded Available options:
unsubmitted, pending, approved, rejected, auto_approved Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
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>"
}
]
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/email/drafts/{draft_id}"
payload = {
"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>"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'}]
})
};
fetch('https://api-sandbox.featherhq.com/v1/email/drafts/{draft_id}', 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://api-sandbox.featherhq.com/v1/email/drafts/{draft_id}",
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([
'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>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api-sandbox.featherhq.com/v1/email/drafts/{draft_id}"
payload := strings.NewReader("{\n \"subject\": \"<string>\",\n \"body_html\": \"<string>\",\n \"body_text\": \"<string>\",\n \"to\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"cc\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"reply_to\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api-sandbox.featherhq.com/v1/email/drafts/{draft_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"subject\": \"<string>\",\n \"body_html\": \"<string>\",\n \"body_text\": \"<string>\",\n \"to\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"cc\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"reply_to\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/email/drafts/{draft_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subject\": \"<string>\",\n \"body_html\": \"<string>\",\n \"body_text\": \"<string>\",\n \"to\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"cc\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"reply_to\": [\n {\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"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",
"mode": "human_only",
"status": "draft",
"approval_state": "unsubmitted",
"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"
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}