Compose Email
curl --request POST \
--url https://api.decodahealth.com/email/compose \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/email/compose"
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>"
}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/email/compose', 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/compose",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/email/compose"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/email/compose")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/email/compose")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"messageId": "<string>",
"threadId": "<string>",
"error": "<string>",
"message": {
"id": "<string>",
"threadId": "<string>",
"subject": "<string>",
"bodyText": "<string>",
"bodyHtml": "<string>",
"snippet": "<string>",
"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",
"participants": [],
"attachments": [],
"openCount": 0,
"uniqueOpenCount": 0,
"clickCount": 0,
"uniqueClickCount": 0,
"firstOpenedDate": "2023-11-07T05:31:56Z",
"lastOpenedDate": "2023-11-07T05:31:56Z"
},
"threadListItem": {
"id": "<string>",
"subject": "<string>",
"snippet": "<string>",
"isRead": true,
"isStarred": true,
"isArchived": true,
"firstMessageDate": "2023-11-07T05:31:56Z",
"lastMessageDate": "2023-11-07T05:31:56Z",
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"messageCount": 0,
"fromContact": {
"id": "<string>",
"email": "<string>",
"displayName": "<string>",
"contactType": "EXTERNAL",
"patientIds": [
"<string>"
],
"patients": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"toContacts": [],
"awaitingReply": false,
"hasAttachments": false,
"primaryPatientId": "<string>",
"openCount": 0,
"clickCount": 0,
"lastOpenedDate": "2023-11-07T05:31:56Z"
}
}Email
Compose Email
Compose and send a new email. Supports file attachments via multipart/form-data.
POST
/
email
/
compose
Compose Email
curl --request POST \
--url https://api.decodahealth.com/email/compose \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/email/compose"
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>"
}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/email/compose', 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/compose",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/email/compose"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/email/compose")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/email/compose")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"messageId": "<string>",
"threadId": "<string>",
"error": "<string>",
"message": {
"id": "<string>",
"threadId": "<string>",
"subject": "<string>",
"bodyText": "<string>",
"bodyHtml": "<string>",
"snippet": "<string>",
"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",
"participants": [],
"attachments": [],
"openCount": 0,
"uniqueOpenCount": 0,
"clickCount": 0,
"uniqueClickCount": 0,
"firstOpenedDate": "2023-11-07T05:31:56Z",
"lastOpenedDate": "2023-11-07T05:31:56Z"
},
"threadListItem": {
"id": "<string>",
"subject": "<string>",
"snippet": "<string>",
"isRead": true,
"isStarred": true,
"isArchived": true,
"firstMessageDate": "2023-11-07T05:31:56Z",
"lastMessageDate": "2023-11-07T05:31:56Z",
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"messageCount": 0,
"fromContact": {
"id": "<string>",
"email": "<string>",
"displayName": "<string>",
"contactType": "EXTERNAL",
"patientIds": [
"<string>"
],
"patients": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"toContacts": [],
"awaitingReply": false,
"hasAttachments": false,
"primaryPatientId": "<string>",
"openCount": 0,
"clickCount": 0,
"lastOpenedDate": "2023-11-07T05:31:56Z"
}
}Headers
The tenant you are making this request on behalf of
Your api key
Response
200 - application/json
Successful Response
Response after sending an email.
Email message in API responses.
Show child attributes
Show child attributes
Email thread in list responses (without full messages).
Show child attributes
Show child attributes
⌘I
