Create an outbound sequence, as a draft
curl --request POST \
--url http://localhost:8080/sequences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"steps": [
{
"channel": "whatsapp",
"content": {
"type": "whatsapp_template",
"template_name": "<string>",
"template_language": "<string>",
"variables": {}
},
"delay_minutes": 64800
}
],
"settings": {
"block_active_elsewhere": true,
"block_contacted_before": true,
"respect_office_hours": true,
"office_hours_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fit_cutoff": 87
},
"brief": "<string>",
"reply_instructions": "<string>"
}
'import requests
url = "http://localhost:8080/sequences"
payload = {
"name": "<string>",
"steps": [
{
"channel": "whatsapp",
"content": {
"type": "whatsapp_template",
"template_name": "<string>",
"template_language": "<string>",
"variables": {}
},
"delay_minutes": 64800
}
],
"settings": {
"block_active_elsewhere": True,
"block_contacted_before": True,
"respect_office_hours": True,
"office_hours_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fit_cutoff": 87
},
"brief": "<string>",
"reply_instructions": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
steps: [
{
channel: 'whatsapp',
content: {
type: 'whatsapp_template',
template_name: '<string>',
template_language: '<string>',
variables: {}
},
delay_minutes: 64800
}
],
settings: {
block_active_elsewhere: true,
block_contacted_before: true,
respect_office_hours: true,
office_hours_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
fit_cutoff: 87
},
brief: '<string>',
reply_instructions: '<string>'
})
};
fetch('http://localhost:8080/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_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/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>',
'steps' => [
[
'channel' => 'whatsapp',
'content' => [
'type' => 'whatsapp_template',
'template_name' => '<string>',
'template_language' => '<string>',
'variables' => [
]
],
'delay_minutes' => 64800
]
],
'settings' => [
'block_active_elsewhere' => true,
'block_contacted_before' => true,
'respect_office_hours' => true,
'office_hours_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'fit_cutoff' => 87
],
'brief' => '<string>',
'reply_instructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://localhost:8080/sequences"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"channel\": \"whatsapp\",\n \"content\": {\n \"type\": \"whatsapp_template\",\n \"template_name\": \"<string>\",\n \"template_language\": \"<string>\",\n \"variables\": {}\n },\n \"delay_minutes\": 64800\n }\n ],\n \"settings\": {\n \"block_active_elsewhere\": true,\n \"block_contacted_before\": true,\n \"respect_office_hours\": true,\n \"office_hours_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fit_cutoff\": 87\n },\n \"brief\": \"<string>\",\n \"reply_instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:8080/sequences")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"channel\": \"whatsapp\",\n \"content\": {\n \"type\": \"whatsapp_template\",\n \"template_name\": \"<string>\",\n \"template_language\": \"<string>\",\n \"variables\": {}\n },\n \"delay_minutes\": 64800\n }\n ],\n \"settings\": {\n \"block_active_elsewhere\": true,\n \"block_contacted_before\": true,\n \"respect_office_hours\": true,\n \"office_hours_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fit_cutoff\": 87\n },\n \"brief\": \"<string>\",\n \"reply_instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/sequences")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"channel\": \"whatsapp\",\n \"content\": {\n \"type\": \"whatsapp_template\",\n \"template_name\": \"<string>\",\n \"template_language\": \"<string>\",\n \"variables\": {}\n },\n \"delay_minutes\": 64800\n }\n ],\n \"settings\": {\n \"block_active_elsewhere\": true,\n \"block_contacted_before\": true,\n \"respect_office_hours\": true,\n \"office_hours_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fit_cutoff\": 87\n },\n \"brief\": \"<string>\",\n \"reply_instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"steps": [
{
"channel": "whatsapp",
"content": {
"type": "whatsapp_template",
"template_name": "<string>",
"template_language": "<string>",
"variables": {}
},
"delay_minutes": 64800
}
],
"settings": {
"block_active_elsewhere": true,
"block_contacted_before": true,
"respect_office_hours": true,
"office_hours_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"brief": "<string>",
"reply_instructions": "<string>",
"criteria": {
"must": [
{
"label": "<string>",
"text": "<string>"
}
],
"nice": [
{
"label": "<string>",
"text": "<string>",
"grade": "high"
}
]
},
"columns": [
{
"key": "<string>",
"label": "<string>",
"path": "<string>",
"type": "string"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Sequences
Create an outbound sequence, as a draft
Create an outbound sequence as a draft, with an optional brief, qualification criteria, settings and steps. Use as the first call of the enroll-first flow.
POST
/
sequences
Create an outbound sequence, as a draft
curl --request POST \
--url http://localhost:8080/sequences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"steps": [
{
"channel": "whatsapp",
"content": {
"type": "whatsapp_template",
"template_name": "<string>",
"template_language": "<string>",
"variables": {}
},
"delay_minutes": 64800
}
],
"settings": {
"block_active_elsewhere": true,
"block_contacted_before": true,
"respect_office_hours": true,
"office_hours_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fit_cutoff": 87
},
"brief": "<string>",
"reply_instructions": "<string>"
}
'import requests
url = "http://localhost:8080/sequences"
payload = {
"name": "<string>",
"steps": [
{
"channel": "whatsapp",
"content": {
"type": "whatsapp_template",
"template_name": "<string>",
"template_language": "<string>",
"variables": {}
},
"delay_minutes": 64800
}
],
"settings": {
"block_active_elsewhere": True,
"block_contacted_before": True,
"respect_office_hours": True,
"office_hours_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fit_cutoff": 87
},
"brief": "<string>",
"reply_instructions": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
steps: [
{
channel: 'whatsapp',
content: {
type: 'whatsapp_template',
template_name: '<string>',
template_language: '<string>',
variables: {}
},
delay_minutes: 64800
}
],
settings: {
block_active_elsewhere: true,
block_contacted_before: true,
respect_office_hours: true,
office_hours_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
fit_cutoff: 87
},
brief: '<string>',
reply_instructions: '<string>'
})
};
fetch('http://localhost:8080/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_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/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>',
'steps' => [
[
'channel' => 'whatsapp',
'content' => [
'type' => 'whatsapp_template',
'template_name' => '<string>',
'template_language' => '<string>',
'variables' => [
]
],
'delay_minutes' => 64800
]
],
'settings' => [
'block_active_elsewhere' => true,
'block_contacted_before' => true,
'respect_office_hours' => true,
'office_hours_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'fit_cutoff' => 87
],
'brief' => '<string>',
'reply_instructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://localhost:8080/sequences"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"channel\": \"whatsapp\",\n \"content\": {\n \"type\": \"whatsapp_template\",\n \"template_name\": \"<string>\",\n \"template_language\": \"<string>\",\n \"variables\": {}\n },\n \"delay_minutes\": 64800\n }\n ],\n \"settings\": {\n \"block_active_elsewhere\": true,\n \"block_contacted_before\": true,\n \"respect_office_hours\": true,\n \"office_hours_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fit_cutoff\": 87\n },\n \"brief\": \"<string>\",\n \"reply_instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:8080/sequences")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"channel\": \"whatsapp\",\n \"content\": {\n \"type\": \"whatsapp_template\",\n \"template_name\": \"<string>\",\n \"template_language\": \"<string>\",\n \"variables\": {}\n },\n \"delay_minutes\": 64800\n }\n ],\n \"settings\": {\n \"block_active_elsewhere\": true,\n \"block_contacted_before\": true,\n \"respect_office_hours\": true,\n \"office_hours_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fit_cutoff\": 87\n },\n \"brief\": \"<string>\",\n \"reply_instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/sequences")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"channel\": \"whatsapp\",\n \"content\": {\n \"type\": \"whatsapp_template\",\n \"template_name\": \"<string>\",\n \"template_language\": \"<string>\",\n \"variables\": {}\n },\n \"delay_minutes\": 64800\n }\n ],\n \"settings\": {\n \"block_active_elsewhere\": true,\n \"block_contacted_before\": true,\n \"respect_office_hours\": true,\n \"office_hours_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fit_cutoff\": 87\n },\n \"brief\": \"<string>\",\n \"reply_instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"steps": [
{
"channel": "whatsapp",
"content": {
"type": "whatsapp_template",
"template_name": "<string>",
"template_language": "<string>",
"variables": {}
},
"delay_minutes": 64800
}
],
"settings": {
"block_active_elsewhere": true,
"block_contacted_before": true,
"respect_office_hours": true,
"office_hours_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"brief": "<string>",
"reply_instructions": "<string>",
"criteria": {
"must": [
{
"label": "<string>",
"text": "<string>"
}
],
"nice": [
{
"label": "<string>",
"text": "<string>",
"grade": "high"
}
]
},
"columns": [
{
"key": "<string>",
"label": "<string>",
"path": "<string>",
"type": "string"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Required string length:
1 - 200- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Show child attributes
Show child attributes
What this campaign is about and who it targets, plain text — context for judging and reply handling.
Maximum string length:
10000Qualification checklist: must-haves gate, nice-to-haves rank. Editable later; judge dispatches default to it.
Show child attributes
Show child attributes
Response
Default Response
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Available options:
draft, active, paused - Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum array length:
12Show child attributes
Show child attributes
Was this page helpful?