Update Draft
curl --request PUT \
--url https://api.decodahealth.com/email/drafts/{draft_id} \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <api-key>' \
--data '
{
"to": [
"<string>"
],
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"subject": "<string>",
"bodyHtml": "<string>",
"bodyText": "<string>"
}
'import requests
url = "https://api.decodahealth.com/email/drafts/{draft_id}"
payload = {
"to": ["<string>"],
"cc": ["<string>"],
"bcc": ["<string>"],
"subject": "<string>",
"bodyHtml": "<string>",
"bodyText": "<string>"
}
headers = {
"TENANT": "<api-key>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
TENANT: '<api-key>',
'API-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
to: ['<string>'],
cc: ['<string>'],
bcc: ['<string>'],
subject: '<string>',
bodyHtml: '<string>',
bodyText: '<string>'
})
};
fetch('https://api.decodahealth.com/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.decodahealth.com/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 => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'to' => [
'<string>'
],
'cc' => [
'<string>'
],
'bcc' => [
'<string>'
],
'subject' => '<string>',
'bodyHtml' => '<string>',
'bodyText' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <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.decodahealth.com/email/drafts/{draft_id}"
payload := strings.NewReader("{\n \"to\": [\n \"<string>\"\n ],\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"bodyHtml\": \"<string>\",\n \"bodyText\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("TENANT", "<api-key>")
req.Header.Add("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.put("https://api.decodahealth.com/email/drafts/{draft_id}")
.header("TENANT", "<api-key>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"to\": [\n \"<string>\"\n ],\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"bodyHtml\": \"<string>\",\n \"bodyText\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/email/drafts/{draft_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["TENANT"] = '<api-key>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": [\n \"<string>\"\n ],\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"bodyHtml\": \"<string>\",\n \"bodyText\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"threadId": "<string>",
"subject": "<string>",
"bodyText": "<string>",
"bodyHtml": "<string>",
"snippet": "<string>",
"status": "DRAFT",
"direction": "INBOUND",
"sentDate": "2023-11-07T05:31:56Z",
"deliveredDate": "2023-11-07T05:31:56Z",
"isRead": true,
"isStarred": true,
"isDraft": true,
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"messageType": "CUSTOM",
"draftKind": "NEW",
"sentBy": {
"id": "<string>",
"name": "<string>"
},
"participants": [],
"attachments": [],
"openCount": 0,
"uniqueOpenCount": 0,
"clickCount": 0,
"uniqueClickCount": 0,
"firstOpenedDate": "2023-11-07T05:31:56Z",
"lastOpenedDate": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Email
Update Draft
Update an existing draft.
PUT
/
email
/
drafts
/
{draft_id}
Update Draft
curl --request PUT \
--url https://api.decodahealth.com/email/drafts/{draft_id} \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <api-key>' \
--data '
{
"to": [
"<string>"
],
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"subject": "<string>",
"bodyHtml": "<string>",
"bodyText": "<string>"
}
'import requests
url = "https://api.decodahealth.com/email/drafts/{draft_id}"
payload = {
"to": ["<string>"],
"cc": ["<string>"],
"bcc": ["<string>"],
"subject": "<string>",
"bodyHtml": "<string>",
"bodyText": "<string>"
}
headers = {
"TENANT": "<api-key>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
TENANT: '<api-key>',
'API-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
to: ['<string>'],
cc: ['<string>'],
bcc: ['<string>'],
subject: '<string>',
bodyHtml: '<string>',
bodyText: '<string>'
})
};
fetch('https://api.decodahealth.com/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.decodahealth.com/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 => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'to' => [
'<string>'
],
'cc' => [
'<string>'
],
'bcc' => [
'<string>'
],
'subject' => '<string>',
'bodyHtml' => '<string>',
'bodyText' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <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.decodahealth.com/email/drafts/{draft_id}"
payload := strings.NewReader("{\n \"to\": [\n \"<string>\"\n ],\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"bodyHtml\": \"<string>\",\n \"bodyText\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("TENANT", "<api-key>")
req.Header.Add("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.put("https://api.decodahealth.com/email/drafts/{draft_id}")
.header("TENANT", "<api-key>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"to\": [\n \"<string>\"\n ],\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"bodyHtml\": \"<string>\",\n \"bodyText\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/email/drafts/{draft_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["TENANT"] = '<api-key>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": [\n \"<string>\"\n ],\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"bodyHtml\": \"<string>\",\n \"bodyText\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"threadId": "<string>",
"subject": "<string>",
"bodyText": "<string>",
"bodyHtml": "<string>",
"snippet": "<string>",
"status": "DRAFT",
"direction": "INBOUND",
"sentDate": "2023-11-07T05:31:56Z",
"deliveredDate": "2023-11-07T05:31:56Z",
"isRead": true,
"isStarred": true,
"isDraft": true,
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"messageType": "CUSTOM",
"draftKind": "NEW",
"sentBy": {
"id": "<string>",
"name": "<string>"
},
"participants": [],
"attachments": [],
"openCount": 0,
"uniqueOpenCount": 0,
"clickCount": 0,
"uniqueClickCount": 0,
"firstOpenedDate": "2023-11-07T05:31:56Z",
"lastOpenedDate": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
The tenant you are making this request on behalf of
Your api key
Path Parameters
Body
application/json
Response
Successful Response
Email message in API responses.
Status of an email message through its lifecycle.
Available options:
DRAFT, QUEUED, SENDING, SENT, DELIVERED, RECEIVED, FAILED, BOUNCED, COMPLAINED Direction of an email message.
Available options:
INBOUND, OUTBOUND Type of email message.
Available options:
CUSTOM, INVOICE, TENANT_CREATED, PROVIDER_INVITE, PURCHASE_ORDER, RECEIPT, NOTIFICATION, WEBHOOK_FAILED, FORM, BLAST, OUTREACH How a draft was composed, so it resumes in the matching composer.
Only meaningful for DRAFT-status messages (NULL otherwise). REPLY/FORWARD drafts live inside an existing thread; a FORWARD draft must reopen in the forward composer (new thread, no in-reply-to) rather than as a reply.
Available options:
NEW, REPLY, FORWARD The staff member who sent an email, for internal attribution.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes

