Skip to main content
POST
/
email
/
compose
Compose Email
curl --request POST \
  --url https://api.decodahealth.com/email/compose \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "to": [
    "<string>"
  ],
  "subject": "<string>",
  "cc": [],
  "bcc": [],
  "bodyHtml": "<string>",
  "bodyText": "<string>",
  "patientId": "<string>"
}
'
import requests

url = "https://api.decodahealth.com/email/compose"

payload = {
"to": ["<string>"],
"subject": "<string>",
"cc": [],
"bcc": [],
"bodyHtml": "<string>",
"bodyText": "<string>",
"patientId": "<string>"
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: ['<string>'],
subject: '<string>',
cc: [],
bcc: [],
bodyHtml: '<string>',
bodyText: '<string>',
patientId: '<string>'
})
};

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_POSTFIELDS => json_encode([
'to' => [
'<string>'
],
'subject' => '<string>',
'cc' => [

],
'bcc' => [

],
'bodyHtml' => '<string>',
'bodyText' => '<string>',
'patientId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.decodahealth.com/email/compose"

payload := strings.NewReader("{\n \"to\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"cc\": [],\n \"bcc\": [],\n \"bodyHtml\": \"<string>\",\n \"bodyText\": \"<string>\",\n \"patientId\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("TENANT", "<tenant>")
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.post("https://api.decodahealth.com/email/compose")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"to\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"cc\": [],\n \"bcc\": [],\n \"bodyHtml\": \"<string>\",\n \"bodyText\": \"<string>\",\n \"patientId\": \"<string>\"\n}")
.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>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"cc\": [],\n \"bcc\": [],\n \"bodyHtml\": \"<string>\",\n \"bodyText\": \"<string>\",\n \"patientId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "messageId": "<string>",
  "threadId": "<string>",
  "error": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Request to compose and send a new email.

to
string[]
required

Recipient email addresses

Minimum array length: 1
subject
string
required
Required string length: 1 - 500
cc
string[]

CC recipients

bcc
string[]

BCC recipients

bodyHtml
string | null
bodyText
string | null
patientId
string | null

Link email to a patient

Response

Successful Response

Response after sending an email.

success
boolean
required
messageId
string | null
threadId
string | null
error
string | null