Activate Outreach Sequence
curl --request POST \
--url https://api.decodahealth.com/comms/outreach-sequences/{sequence_id}/activate \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/comms/outreach-sequences/{sequence_id}/activate"
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/comms/outreach-sequences/{sequence_id}/activate', 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/{sequence_id}/activate",
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/comms/outreach-sequences/{sequence_id}/activate"
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/comms/outreach-sequences/{sequence_id}/activate")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/comms/outreach-sequences/{sequence_id}/activate")
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{
"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
Activate Outreach Sequence
POST
/
comms
/
outreach-sequences
/
{sequence_id}
/
activate
Activate Outreach Sequence
curl --request POST \
--url https://api.decodahealth.com/comms/outreach-sequences/{sequence_id}/activate \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/comms/outreach-sequences/{sequence_id}/activate"
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/comms/outreach-sequences/{sequence_id}/activate', 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/{sequence_id}/activate",
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/comms/outreach-sequences/{sequence_id}/activate"
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/comms/outreach-sequences/{sequence_id}/activate")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/comms/outreach-sequences/{sequence_id}/activate")
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{
"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
Path Parameters
Query Parameters
Recurring sequences only: fire an initial wave now, then continue on schedule.
Response
Successful Response
Available options:
DRAFT, ACTIVE, PAUSED Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
