Create Outreach Sequence
curl --request POST \
--url https://api.decodahealth.com/comms/outreach-sequences \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"name": "<string>",
"cohortId": "<string>",
"description": "<string>",
"cooldownDays": 90,
"isMarketing": true,
"steps": [
{
"effectConfig": {
"template": "",
"attachments": [
{
"gcsPath": "<string>",
"filename": "<string>"
}
]
},
"id": "<string>",
"delayMinutes": 0,
"displayOrder": 0,
"isActive": true
}
],
"rrule": "<string>",
"recurrenceStartDate": "2023-11-07T05:31:56Z",
"recurrenceEndDate": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.decodahealth.com/comms/outreach-sequences"
payload = {
"name": "<string>",
"cohortId": "<string>",
"description": "<string>",
"cooldownDays": 90,
"isMarketing": True,
"steps": [
{
"effectConfig": {
"template": "",
"attachments": [
{
"gcsPath": "<string>",
"filename": "<string>"
}
]
},
"id": "<string>",
"delayMinutes": 0,
"displayOrder": 0,
"isActive": True
}
],
"rrule": "<string>",
"recurrenceStartDate": "2023-11-07T05:31:56Z",
"recurrenceEndDate": "2023-11-07T05:31:56Z"
}
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({
name: '<string>',
cohortId: '<string>',
description: '<string>',
cooldownDays: 90,
isMarketing: true,
steps: [
{
effectConfig: {template: '', attachments: [{gcsPath: '<string>', filename: '<string>'}]},
id: '<string>',
delayMinutes: 0,
displayOrder: 0,
isActive: true
}
],
rrule: '<string>',
recurrenceStartDate: '2023-11-07T05:31:56Z',
recurrenceEndDate: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.decodahealth.com/comms/outreach-sequences', 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/outreach-sequences",
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([
'name' => '<string>',
'cohortId' => '<string>',
'description' => '<string>',
'cooldownDays' => 90,
'isMarketing' => true,
'steps' => [
[
'effectConfig' => [
'template' => '',
'attachments' => [
[
'gcsPath' => '<string>',
'filename' => '<string>'
]
]
],
'id' => '<string>',
'delayMinutes' => 0,
'displayOrder' => 0,
'isActive' => true
]
],
'rrule' => '<string>',
'recurrenceStartDate' => '2023-11-07T05:31:56Z',
'recurrenceEndDate' => '2023-11-07T05:31:56Z'
]),
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/outreach-sequences"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cohortId\": \"<string>\",\n \"description\": \"<string>\",\n \"cooldownDays\": 90,\n \"isMarketing\": true,\n \"steps\": [\n {\n \"effectConfig\": {\n \"template\": \"\",\n \"attachments\": [\n {\n \"gcsPath\": \"<string>\",\n \"filename\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"delayMinutes\": 0,\n \"displayOrder\": 0,\n \"isActive\": true\n }\n ],\n \"rrule\": \"<string>\",\n \"recurrenceStartDate\": \"2023-11-07T05:31:56Z\",\n \"recurrenceEndDate\": \"2023-11-07T05:31:56Z\"\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/outreach-sequences")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cohortId\": \"<string>\",\n \"description\": \"<string>\",\n \"cooldownDays\": 90,\n \"isMarketing\": true,\n \"steps\": [\n {\n \"effectConfig\": {\n \"template\": \"\",\n \"attachments\": [\n {\n \"gcsPath\": \"<string>\",\n \"filename\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"delayMinutes\": 0,\n \"displayOrder\": 0,\n \"isActive\": true\n }\n ],\n \"rrule\": \"<string>\",\n \"recurrenceStartDate\": \"2023-11-07T05:31:56Z\",\n \"recurrenceEndDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/comms/outreach-sequences")
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 \"name\": \"<string>\",\n \"cohortId\": \"<string>\",\n \"description\": \"<string>\",\n \"cooldownDays\": 90,\n \"isMarketing\": true,\n \"steps\": [\n {\n \"effectConfig\": {\n \"template\": \"\",\n \"attachments\": [\n {\n \"gcsPath\": \"<string>\",\n \"filename\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"delayMinutes\": 0,\n \"displayOrder\": 0,\n \"isActive\": true\n }\n ],\n \"rrule\": \"<string>\",\n \"recurrenceStartDate\": \"2023-11-07T05:31:56Z\",\n \"recurrenceEndDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"cohortId": "<string>",
"cooldownDays": 123,
"isMarketing": true,
"createdById": "<string>",
"steps": [
{
"id": "<string>",
"delayMinutes": 123,
"config": {},
"displayOrder": 123,
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"sentCount": 0,
"skippedCount": 0,
"openCount": 0,
"uniqueOpenCount": 0,
"clickCount": 0,
"uniqueClickCount": 0,
"replyCount": 0
}
],
"createdDate": "2023-11-07T05:31:56Z",
"cohortName": "<string>",
"enrollmentStats": {
"active": 0,
"completed": 0,
"exited": 0,
"total": 0
},
"updatedDate": "2023-11-07T05:31:56Z",
"rrule": "<string>",
"recurrenceStartDate": "2023-11-07T05:31:56Z",
"recurrenceEndDate": "2023-11-07T05:31:56Z",
"recurrenceTimezone": "<string>",
"lastOccurrenceFiredAt": "2023-11-07T05:31:56Z",
"nextSendAt": "2023-11-07T05:31:56Z",
"cooldownWarning": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Outreach Sequences
Create Outreach Sequence
POST
/
comms
/
outreach-sequences
Create Outreach Sequence
curl --request POST \
--url https://api.decodahealth.com/comms/outreach-sequences \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"name": "<string>",
"cohortId": "<string>",
"description": "<string>",
"cooldownDays": 90,
"isMarketing": true,
"steps": [
{
"effectConfig": {
"template": "",
"attachments": [
{
"gcsPath": "<string>",
"filename": "<string>"
}
]
},
"id": "<string>",
"delayMinutes": 0,
"displayOrder": 0,
"isActive": true
}
],
"rrule": "<string>",
"recurrenceStartDate": "2023-11-07T05:31:56Z",
"recurrenceEndDate": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.decodahealth.com/comms/outreach-sequences"
payload = {
"name": "<string>",
"cohortId": "<string>",
"description": "<string>",
"cooldownDays": 90,
"isMarketing": True,
"steps": [
{
"effectConfig": {
"template": "",
"attachments": [
{
"gcsPath": "<string>",
"filename": "<string>"
}
]
},
"id": "<string>",
"delayMinutes": 0,
"displayOrder": 0,
"isActive": True
}
],
"rrule": "<string>",
"recurrenceStartDate": "2023-11-07T05:31:56Z",
"recurrenceEndDate": "2023-11-07T05:31:56Z"
}
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({
name: '<string>',
cohortId: '<string>',
description: '<string>',
cooldownDays: 90,
isMarketing: true,
steps: [
{
effectConfig: {template: '', attachments: [{gcsPath: '<string>', filename: '<string>'}]},
id: '<string>',
delayMinutes: 0,
displayOrder: 0,
isActive: true
}
],
rrule: '<string>',
recurrenceStartDate: '2023-11-07T05:31:56Z',
recurrenceEndDate: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.decodahealth.com/comms/outreach-sequences', 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/outreach-sequences",
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([
'name' => '<string>',
'cohortId' => '<string>',
'description' => '<string>',
'cooldownDays' => 90,
'isMarketing' => true,
'steps' => [
[
'effectConfig' => [
'template' => '',
'attachments' => [
[
'gcsPath' => '<string>',
'filename' => '<string>'
]
]
],
'id' => '<string>',
'delayMinutes' => 0,
'displayOrder' => 0,
'isActive' => true
]
],
'rrule' => '<string>',
'recurrenceStartDate' => '2023-11-07T05:31:56Z',
'recurrenceEndDate' => '2023-11-07T05:31:56Z'
]),
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/outreach-sequences"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cohortId\": \"<string>\",\n \"description\": \"<string>\",\n \"cooldownDays\": 90,\n \"isMarketing\": true,\n \"steps\": [\n {\n \"effectConfig\": {\n \"template\": \"\",\n \"attachments\": [\n {\n \"gcsPath\": \"<string>\",\n \"filename\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"delayMinutes\": 0,\n \"displayOrder\": 0,\n \"isActive\": true\n }\n ],\n \"rrule\": \"<string>\",\n \"recurrenceStartDate\": \"2023-11-07T05:31:56Z\",\n \"recurrenceEndDate\": \"2023-11-07T05:31:56Z\"\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/outreach-sequences")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cohortId\": \"<string>\",\n \"description\": \"<string>\",\n \"cooldownDays\": 90,\n \"isMarketing\": true,\n \"steps\": [\n {\n \"effectConfig\": {\n \"template\": \"\",\n \"attachments\": [\n {\n \"gcsPath\": \"<string>\",\n \"filename\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"delayMinutes\": 0,\n \"displayOrder\": 0,\n \"isActive\": true\n }\n ],\n \"rrule\": \"<string>\",\n \"recurrenceStartDate\": \"2023-11-07T05:31:56Z\",\n \"recurrenceEndDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/comms/outreach-sequences")
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 \"name\": \"<string>\",\n \"cohortId\": \"<string>\",\n \"description\": \"<string>\",\n \"cooldownDays\": 90,\n \"isMarketing\": true,\n \"steps\": [\n {\n \"effectConfig\": {\n \"template\": \"\",\n \"attachments\": [\n {\n \"gcsPath\": \"<string>\",\n \"filename\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"delayMinutes\": 0,\n \"displayOrder\": 0,\n \"isActive\": true\n }\n ],\n \"rrule\": \"<string>\",\n \"recurrenceStartDate\": \"2023-11-07T05:31:56Z\",\n \"recurrenceEndDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"cohortId": "<string>",
"cooldownDays": 123,
"isMarketing": true,
"createdById": "<string>",
"steps": [
{
"id": "<string>",
"delayMinutes": 123,
"config": {},
"displayOrder": 123,
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"sentCount": 0,
"skippedCount": 0,
"openCount": 0,
"uniqueOpenCount": 0,
"clickCount": 0,
"uniqueClickCount": 0,
"replyCount": 0
}
],
"createdDate": "2023-11-07T05:31:56Z",
"cohortName": "<string>",
"enrollmentStats": {
"active": 0,
"completed": 0,
"exited": 0,
"total": 0
},
"updatedDate": "2023-11-07T05:31:56Z",
"rrule": "<string>",
"recurrenceStartDate": "2023-11-07T05:31:56Z",
"recurrenceEndDate": "2023-11-07T05:31:56Z",
"recurrenceTimezone": "<string>",
"lastOccurrenceFiredAt": "2023-11-07T05:31:56Z",
"nextSendAt": "2023-11-07T05:31:56Z",
"cooldownWarning": "<string>"
}{
"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
Minimum string length:
1Show child attributes
Show child attributes
Response
Successful Response
Available options:
DRAFT, ACTIVE, PAUSED Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
