Create a sequence
curl --request POST \
--url http://localhost:8080/sequences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"or": [
{
"and": [
{
"type": "<string>"
}
]
}
]
},
"steps": [
{
"action": {
"type": "<string>",
"data": {
"from_email": "<string>",
"email_subject": "<string>",
"email_body": "<string>",
"email_sender_name": "<string>",
"email_is_transactional": true
}
},
"delay_in_minutes": 1
}
],
"name": "New Sequence",
"custom_id": "<string>",
"is_continuous": true,
"respect_office_hours": true,
"office_hours_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "http://localhost:8080/sequences"
payload = {
"filter": { "or": [{ "and": [{ "type": "<string>" }] }] },
"steps": [
{
"action": {
"type": "<string>",
"data": {
"from_email": "<string>",
"email_subject": "<string>",
"email_body": "<string>",
"email_sender_name": "<string>",
"email_is_transactional": True
}
},
"delay_in_minutes": 1
}
],
"name": "New Sequence",
"custom_id": "<string>",
"is_continuous": True,
"respect_office_hours": True,
"office_hours_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
filter: {or: [{and: [{type: '<string>'}]}]},
steps: [
{
action: {
type: '<string>',
data: {
from_email: '<string>',
email_subject: '<string>',
email_body: '<string>',
email_sender_name: '<string>',
email_is_transactional: true
}
},
delay_in_minutes: 1
}
],
name: 'New Sequence',
custom_id: '<string>',
is_continuous: true,
respect_office_hours: true,
office_hours_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
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([
'filter' => [
'or' => [
[
'and' => [
[
'type' => '<string>'
]
]
]
]
],
'steps' => [
[
'action' => [
'type' => '<string>',
'data' => [
'from_email' => '<string>',
'email_subject' => '<string>',
'email_body' => '<string>',
'email_sender_name' => '<string>',
'email_is_transactional' => true
]
],
'delay_in_minutes' => 1
]
],
'name' => 'New Sequence',
'custom_id' => '<string>',
'is_continuous' => true,
'respect_office_hours' => true,
'office_hours_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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 \"filter\": {\n \"or\": [\n {\n \"and\": [\n {\n \"type\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"steps\": [\n {\n \"action\": {\n \"type\": \"<string>\",\n \"data\": {\n \"from_email\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"email_sender_name\": \"<string>\",\n \"email_is_transactional\": true\n }\n },\n \"delay_in_minutes\": 1\n }\n ],\n \"name\": \"New Sequence\",\n \"custom_id\": \"<string>\",\n \"is_continuous\": true,\n \"respect_office_hours\": true,\n \"office_hours_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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 \"filter\": {\n \"or\": [\n {\n \"and\": [\n {\n \"type\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"steps\": [\n {\n \"action\": {\n \"type\": \"<string>\",\n \"data\": {\n \"from_email\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"email_sender_name\": \"<string>\",\n \"email_is_transactional\": true\n }\n },\n \"delay_in_minutes\": 1\n }\n ],\n \"name\": \"New Sequence\",\n \"custom_id\": \"<string>\",\n \"is_continuous\": true,\n \"respect_office_hours\": true,\n \"office_hours_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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 \"filter\": {\n \"or\": [\n {\n \"and\": [\n {\n \"type\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"steps\": [\n {\n \"action\": {\n \"type\": \"<string>\",\n \"data\": {\n \"from_email\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"email_sender_name\": \"<string>\",\n \"email_is_transactional\": true\n }\n },\n \"delay_in_minutes\": 1\n }\n ],\n \"name\": \"New Sequence\",\n \"custom_id\": \"<string>\",\n \"is_continuous\": true,\n \"respect_office_hours\": true,\n \"office_hours_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}AI Outbound Sequencing
Create a sequence
Create a sequence. Use when driving the outbound-sequencing engine programmatically.
POST
/
sequences
Create a sequence
curl --request POST \
--url http://localhost:8080/sequences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"or": [
{
"and": [
{
"type": "<string>"
}
]
}
]
},
"steps": [
{
"action": {
"type": "<string>",
"data": {
"from_email": "<string>",
"email_subject": "<string>",
"email_body": "<string>",
"email_sender_name": "<string>",
"email_is_transactional": true
}
},
"delay_in_minutes": 1
}
],
"name": "New Sequence",
"custom_id": "<string>",
"is_continuous": true,
"respect_office_hours": true,
"office_hours_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "http://localhost:8080/sequences"
payload = {
"filter": { "or": [{ "and": [{ "type": "<string>" }] }] },
"steps": [
{
"action": {
"type": "<string>",
"data": {
"from_email": "<string>",
"email_subject": "<string>",
"email_body": "<string>",
"email_sender_name": "<string>",
"email_is_transactional": True
}
},
"delay_in_minutes": 1
}
],
"name": "New Sequence",
"custom_id": "<string>",
"is_continuous": True,
"respect_office_hours": True,
"office_hours_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
filter: {or: [{and: [{type: '<string>'}]}]},
steps: [
{
action: {
type: '<string>',
data: {
from_email: '<string>',
email_subject: '<string>',
email_body: '<string>',
email_sender_name: '<string>',
email_is_transactional: true
}
},
delay_in_minutes: 1
}
],
name: 'New Sequence',
custom_id: '<string>',
is_continuous: true,
respect_office_hours: true,
office_hours_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
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([
'filter' => [
'or' => [
[
'and' => [
[
'type' => '<string>'
]
]
]
]
],
'steps' => [
[
'action' => [
'type' => '<string>',
'data' => [
'from_email' => '<string>',
'email_subject' => '<string>',
'email_body' => '<string>',
'email_sender_name' => '<string>',
'email_is_transactional' => true
]
],
'delay_in_minutes' => 1
]
],
'name' => 'New Sequence',
'custom_id' => '<string>',
'is_continuous' => true,
'respect_office_hours' => true,
'office_hours_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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 \"filter\": {\n \"or\": [\n {\n \"and\": [\n {\n \"type\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"steps\": [\n {\n \"action\": {\n \"type\": \"<string>\",\n \"data\": {\n \"from_email\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"email_sender_name\": \"<string>\",\n \"email_is_transactional\": true\n }\n },\n \"delay_in_minutes\": 1\n }\n ],\n \"name\": \"New Sequence\",\n \"custom_id\": \"<string>\",\n \"is_continuous\": true,\n \"respect_office_hours\": true,\n \"office_hours_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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 \"filter\": {\n \"or\": [\n {\n \"and\": [\n {\n \"type\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"steps\": [\n {\n \"action\": {\n \"type\": \"<string>\",\n \"data\": {\n \"from_email\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"email_sender_name\": \"<string>\",\n \"email_is_transactional\": true\n }\n },\n \"delay_in_minutes\": 1\n }\n ],\n \"name\": \"New Sequence\",\n \"custom_id\": \"<string>\",\n \"is_continuous\": true,\n \"respect_office_hours\": true,\n \"office_hours_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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 \"filter\": {\n \"or\": [\n {\n \"and\": [\n {\n \"type\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"steps\": [\n {\n \"action\": {\n \"type\": \"<string>\",\n \"data\": {\n \"from_email\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"email_sender_name\": \"<string>\",\n \"email_is_transactional\": true\n }\n },\n \"delay_in_minutes\": 1\n }\n ],\n \"name\": \"New Sequence\",\n \"custom_id\": \"<string>\",\n \"is_continuous\": true,\n \"respect_office_hours\": true,\n \"office_hours_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Show child attributes
Show child attributes
Minimum array length:
1Show child attributes
Show child attributes
Hold step sends outside the org office-hours window (defaults to true for new sequences)
Named office-hours config to use as the send window; null = org default hours
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)$Response
Default Response
Was this page helpful?
⌘I