Test Send Blast
curl --request POST \
--url https://api.decodahealth.com/comms/blasts/test-send \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"smsContent": "<string>",
"emailSubject": "<string>",
"emailBodyHtml": "<string>",
"emailPreviewText": "<string>",
"fromName": "<string>",
"attachments": [
"<string>"
],
"isMarketing": false
}
'import requests
url = "https://api.decodahealth.com/comms/blasts/test-send"
payload = {
"smsContent": "<string>",
"emailSubject": "<string>",
"emailBodyHtml": "<string>",
"emailPreviewText": "<string>",
"fromName": "<string>",
"attachments": ["<string>"],
"isMarketing": False
}
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({
smsContent: '<string>',
emailSubject: '<string>',
emailBodyHtml: '<string>',
emailPreviewText: '<string>',
fromName: '<string>',
attachments: ['<string>'],
isMarketing: false
})
};
fetch('https://api.decodahealth.com/comms/blasts/test-send', 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/comms/blasts/test-send",
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([
'smsContent' => '<string>',
'emailSubject' => '<string>',
'emailBodyHtml' => '<string>',
'emailPreviewText' => '<string>',
'fromName' => '<string>',
'attachments' => [
'<string>'
],
'isMarketing' => false
]),
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/comms/blasts/test-send"
payload := strings.NewReader("{\n \"smsContent\": \"<string>\",\n \"emailSubject\": \"<string>\",\n \"emailBodyHtml\": \"<string>\",\n \"emailPreviewText\": \"<string>\",\n \"fromName\": \"<string>\",\n \"attachments\": [\n \"<string>\"\n ],\n \"isMarketing\": false\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/comms/blasts/test-send")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"smsContent\": \"<string>\",\n \"emailSubject\": \"<string>\",\n \"emailBodyHtml\": \"<string>\",\n \"emailPreviewText\": \"<string>\",\n \"fromName\": \"<string>\",\n \"attachments\": [\n \"<string>\"\n ],\n \"isMarketing\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/comms/blasts/test-send")
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 \"smsContent\": \"<string>\",\n \"emailSubject\": \"<string>\",\n \"emailBodyHtml\": \"<string>\",\n \"emailPreviewText\": \"<string>\",\n \"fromName\": \"<string>\",\n \"attachments\": [\n \"<string>\"\n ],\n \"isMarketing\": false\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Message Blasts
Test Send Blast
Send a test blast to the currently authenticated user (no DB record).
POST
/
comms
/
blasts
/
test-send
Test Send Blast
curl --request POST \
--url https://api.decodahealth.com/comms/blasts/test-send \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"smsContent": "<string>",
"emailSubject": "<string>",
"emailBodyHtml": "<string>",
"emailPreviewText": "<string>",
"fromName": "<string>",
"attachments": [
"<string>"
],
"isMarketing": false
}
'import requests
url = "https://api.decodahealth.com/comms/blasts/test-send"
payload = {
"smsContent": "<string>",
"emailSubject": "<string>",
"emailBodyHtml": "<string>",
"emailPreviewText": "<string>",
"fromName": "<string>",
"attachments": ["<string>"],
"isMarketing": False
}
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({
smsContent: '<string>',
emailSubject: '<string>',
emailBodyHtml: '<string>',
emailPreviewText: '<string>',
fromName: '<string>',
attachments: ['<string>'],
isMarketing: false
})
};
fetch('https://api.decodahealth.com/comms/blasts/test-send', 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/comms/blasts/test-send",
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([
'smsContent' => '<string>',
'emailSubject' => '<string>',
'emailBodyHtml' => '<string>',
'emailPreviewText' => '<string>',
'fromName' => '<string>',
'attachments' => [
'<string>'
],
'isMarketing' => false
]),
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/comms/blasts/test-send"
payload := strings.NewReader("{\n \"smsContent\": \"<string>\",\n \"emailSubject\": \"<string>\",\n \"emailBodyHtml\": \"<string>\",\n \"emailPreviewText\": \"<string>\",\n \"fromName\": \"<string>\",\n \"attachments\": [\n \"<string>\"\n ],\n \"isMarketing\": false\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/comms/blasts/test-send")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"smsContent\": \"<string>\",\n \"emailSubject\": \"<string>\",\n \"emailBodyHtml\": \"<string>\",\n \"emailPreviewText\": \"<string>\",\n \"fromName\": \"<string>\",\n \"attachments\": [\n \"<string>\"\n ],\n \"isMarketing\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/comms/blasts/test-send")
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 \"smsContent\": \"<string>\",\n \"emailSubject\": \"<string>\",\n \"emailBodyHtml\": \"<string>\",\n \"emailPreviewText\": \"<string>\",\n \"fromName\": \"<string>\",\n \"attachments\": [\n \"<string>\"\n ],\n \"isMarketing\": false\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Body
application/json
Response
Successful Response
The response is of type Response Test Send Blast Comms Blasts Test Send Post · object.
⌘I
