Create a campaign flow step
curl --request POST \
--url https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"apps": [
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"description": "description",
"name": "name",
"type": {
"name": "name"
}
}
],
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"description": "description",
"flow_path": "flow_path",
"icon_color": "icon_color",
"icon_type": "icon_type",
"metrics": [
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"description": "description",
"expression": "expression",
"name": "name",
"tags": [
"tag"
],
"unit": "unit"
}
],
"name": "name",
"sequence": 1,
"step_name": "step_name",
"tags": [
"tag"
],
"words": {
"person_counting_name": "person_counting_name",
"plural_noun_name": "plural_noun_name",
"rate_name": "rate_name",
"singular_noun_name": "singular_noun_name",
"verb_name": "verb_name"
}
}
'import requests
url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps"
payload = {
"apps": [
{
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"description": "description",
"name": "name",
"type": { "name": "name" }
}
],
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"description": "description",
"flow_path": "flow_path",
"icon_color": "icon_color",
"icon_type": "icon_type",
"metrics": [
{
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"description": "description",
"expression": "expression",
"name": "name",
"tags": ["tag"],
"unit": "unit"
}
],
"name": "name",
"sequence": 1,
"step_name": "step_name",
"tags": ["tag"],
"words": {
"person_counting_name": "person_counting_name",
"plural_noun_name": "plural_noun_name",
"rate_name": "rate_name",
"singular_noun_name": "singular_noun_name",
"verb_name": "verb_name"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
apps: [
{
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
description: 'description',
name: 'name',
type: {name: 'name'}
}
],
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
description: 'description',
flow_path: 'flow_path',
icon_color: 'icon_color',
icon_type: 'icon_type',
metrics: [
{
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
description: 'description',
expression: 'expression',
name: 'name',
tags: ['tag'],
unit: 'unit'
}
],
name: 'name',
sequence: 1,
step_name: 'step_name',
tags: ['tag'],
words: {
person_counting_name: 'person_counting_name',
plural_noun_name: 'plural_noun_name',
rate_name: 'rate_name',
singular_noun_name: 'singular_noun_name',
verb_name: 'verb_name'
}
})
};
fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps', 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.extole.io/v2/campaigns/{campaignId}{version}/flow-steps",
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([
'apps' => [
[
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'description' => 'description',
'name' => 'name',
'type' => [
'name' => 'name'
]
]
],
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'description' => 'description',
'flow_path' => 'flow_path',
'icon_color' => 'icon_color',
'icon_type' => 'icon_type',
'metrics' => [
[
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'description' => 'description',
'expression' => 'expression',
'name' => 'name',
'tags' => [
'tag'
],
'unit' => 'unit'
]
],
'name' => 'name',
'sequence' => 1,
'step_name' => 'step_name',
'tags' => [
'tag'
],
'words' => [
'person_counting_name' => 'person_counting_name',
'plural_noun_name' => 'plural_noun_name',
'rate_name' => 'rate_name',
'singular_noun_name' => 'singular_noun_name',
'verb_name' => 'verb_name'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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 := "https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps"
payload := strings.NewReader("{\n \"apps\": [\n {\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"name\": \"name\",\n \"type\": {\n \"name\": \"name\"\n }\n }\n ],\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"flow_path\": \"flow_path\",\n \"icon_color\": \"icon_color\",\n \"icon_type\": \"icon_type\",\n \"metrics\": [\n {\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"expression\": \"expression\",\n \"name\": \"name\",\n \"tags\": [\n \"tag\"\n ],\n \"unit\": \"unit\"\n }\n ],\n \"name\": \"name\",\n \"sequence\": 1,\n \"step_name\": \"step_name\",\n \"tags\": [\n \"tag\"\n ],\n \"words\": {\n \"person_counting_name\": \"person_counting_name\",\n \"plural_noun_name\": \"plural_noun_name\",\n \"rate_name\": \"rate_name\",\n \"singular_noun_name\": \"singular_noun_name\",\n \"verb_name\": \"verb_name\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.extole.io/v2/campaigns/{campaignId}{version}/flow-steps")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"apps\": [\n {\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"name\": \"name\",\n \"type\": {\n \"name\": \"name\"\n }\n }\n ],\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"flow_path\": \"flow_path\",\n \"icon_color\": \"icon_color\",\n \"icon_type\": \"icon_type\",\n \"metrics\": [\n {\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"expression\": \"expression\",\n \"name\": \"name\",\n \"tags\": [\n \"tag\"\n ],\n \"unit\": \"unit\"\n }\n ],\n \"name\": \"name\",\n \"sequence\": 1,\n \"step_name\": \"step_name\",\n \"tags\": [\n \"tag\"\n ],\n \"words\": {\n \"person_counting_name\": \"person_counting_name\",\n \"plural_noun_name\": \"plural_noun_name\",\n \"rate_name\": \"rate_name\",\n \"singular_noun_name\": \"singular_noun_name\",\n \"verb_name\": \"verb_name\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"apps\": [\n {\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"name\": \"name\",\n \"type\": {\n \"name\": \"name\"\n }\n }\n ],\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"flow_path\": \"flow_path\",\n \"icon_color\": \"icon_color\",\n \"icon_type\": \"icon_type\",\n \"metrics\": [\n {\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"expression\": \"expression\",\n \"name\": \"name\",\n \"tags\": [\n \"tag\"\n ],\n \"unit\": \"unit\"\n }\n ],\n \"name\": \"name\",\n \"sequence\": 1,\n \"step_name\": \"step_name\",\n \"tags\": [\n \"tag\"\n ],\n \"words\": {\n \"person_counting_name\": \"person_counting_name\",\n \"plural_noun_name\": \"plural_noun_name\",\n \"rate_name\": \"rate_name\",\n \"singular_noun_name\": \"singular_noun_name\",\n \"verb_name\": \"verb_name\"\n }\n}"
response = http.request(request)
puts response.read_body{
"apps": [
{
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"description": "<string>",
"id": "<string>",
"name": "<string>",
"type": {
"name": "<string>"
}
}
],
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"description": "<string>",
"flow_path": "<string>",
"flow_step_id": "<string>",
"icon_color": "<string>",
"icon_type": "<string>",
"metrics": [
{
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"description": "<string>",
"expression": "<string>",
"id": "<string>",
"name": "<string>",
"tags": [
"<string>"
],
"unit": "<string>"
}
],
"name": "<string>",
"sequence": 123,
"step_name": "<string>",
"tags": [
"<string>"
],
"words": {
"person_counting_name": "<string>",
"plural_noun_name": "<string>",
"rate_name": "<string>",
"singular_noun_name": "<string>",
"verb_name": "<string>"
}
}Campaign Flow Steps
Create a campaign flow step
Adds a new flow step to the specified campaign. Flow steps are the visual builder blocks of a participant’s journey through a campaign. Returns the created flow step with its server-assigned id.
POST
/
v2
/
campaigns
/
{campaignId}
{version}
/
flow-steps
Create a campaign flow step
curl --request POST \
--url https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"apps": [
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"description": "description",
"name": "name",
"type": {
"name": "name"
}
}
],
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"description": "description",
"flow_path": "flow_path",
"icon_color": "icon_color",
"icon_type": "icon_type",
"metrics": [
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"description": "description",
"expression": "expression",
"name": "name",
"tags": [
"tag"
],
"unit": "unit"
}
],
"name": "name",
"sequence": 1,
"step_name": "step_name",
"tags": [
"tag"
],
"words": {
"person_counting_name": "person_counting_name",
"plural_noun_name": "plural_noun_name",
"rate_name": "rate_name",
"singular_noun_name": "singular_noun_name",
"verb_name": "verb_name"
}
}
'import requests
url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps"
payload = {
"apps": [
{
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"description": "description",
"name": "name",
"type": { "name": "name" }
}
],
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"description": "description",
"flow_path": "flow_path",
"icon_color": "icon_color",
"icon_type": "icon_type",
"metrics": [
{
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"description": "description",
"expression": "expression",
"name": "name",
"tags": ["tag"],
"unit": "unit"
}
],
"name": "name",
"sequence": 1,
"step_name": "step_name",
"tags": ["tag"],
"words": {
"person_counting_name": "person_counting_name",
"plural_noun_name": "plural_noun_name",
"rate_name": "rate_name",
"singular_noun_name": "singular_noun_name",
"verb_name": "verb_name"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
apps: [
{
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
description: 'description',
name: 'name',
type: {name: 'name'}
}
],
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
description: 'description',
flow_path: 'flow_path',
icon_color: 'icon_color',
icon_type: 'icon_type',
metrics: [
{
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
description: 'description',
expression: 'expression',
name: 'name',
tags: ['tag'],
unit: 'unit'
}
],
name: 'name',
sequence: 1,
step_name: 'step_name',
tags: ['tag'],
words: {
person_counting_name: 'person_counting_name',
plural_noun_name: 'plural_noun_name',
rate_name: 'rate_name',
singular_noun_name: 'singular_noun_name',
verb_name: 'verb_name'
}
})
};
fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps', 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.extole.io/v2/campaigns/{campaignId}{version}/flow-steps",
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([
'apps' => [
[
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'description' => 'description',
'name' => 'name',
'type' => [
'name' => 'name'
]
]
],
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'description' => 'description',
'flow_path' => 'flow_path',
'icon_color' => 'icon_color',
'icon_type' => 'icon_type',
'metrics' => [
[
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'description' => 'description',
'expression' => 'expression',
'name' => 'name',
'tags' => [
'tag'
],
'unit' => 'unit'
]
],
'name' => 'name',
'sequence' => 1,
'step_name' => 'step_name',
'tags' => [
'tag'
],
'words' => [
'person_counting_name' => 'person_counting_name',
'plural_noun_name' => 'plural_noun_name',
'rate_name' => 'rate_name',
'singular_noun_name' => 'singular_noun_name',
'verb_name' => 'verb_name'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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 := "https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps"
payload := strings.NewReader("{\n \"apps\": [\n {\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"name\": \"name\",\n \"type\": {\n \"name\": \"name\"\n }\n }\n ],\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"flow_path\": \"flow_path\",\n \"icon_color\": \"icon_color\",\n \"icon_type\": \"icon_type\",\n \"metrics\": [\n {\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"expression\": \"expression\",\n \"name\": \"name\",\n \"tags\": [\n \"tag\"\n ],\n \"unit\": \"unit\"\n }\n ],\n \"name\": \"name\",\n \"sequence\": 1,\n \"step_name\": \"step_name\",\n \"tags\": [\n \"tag\"\n ],\n \"words\": {\n \"person_counting_name\": \"person_counting_name\",\n \"plural_noun_name\": \"plural_noun_name\",\n \"rate_name\": \"rate_name\",\n \"singular_noun_name\": \"singular_noun_name\",\n \"verb_name\": \"verb_name\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.extole.io/v2/campaigns/{campaignId}{version}/flow-steps")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"apps\": [\n {\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"name\": \"name\",\n \"type\": {\n \"name\": \"name\"\n }\n }\n ],\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"flow_path\": \"flow_path\",\n \"icon_color\": \"icon_color\",\n \"icon_type\": \"icon_type\",\n \"metrics\": [\n {\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"expression\": \"expression\",\n \"name\": \"name\",\n \"tags\": [\n \"tag\"\n ],\n \"unit\": \"unit\"\n }\n ],\n \"name\": \"name\",\n \"sequence\": 1,\n \"step_name\": \"step_name\",\n \"tags\": [\n \"tag\"\n ],\n \"words\": {\n \"person_counting_name\": \"person_counting_name\",\n \"plural_noun_name\": \"plural_noun_name\",\n \"rate_name\": \"rate_name\",\n \"singular_noun_name\": \"singular_noun_name\",\n \"verb_name\": \"verb_name\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"apps\": [\n {\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"name\": \"name\",\n \"type\": {\n \"name\": \"name\"\n }\n }\n ],\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"flow_path\": \"flow_path\",\n \"icon_color\": \"icon_color\",\n \"icon_type\": \"icon_type\",\n \"metrics\": [\n {\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"expression\": \"expression\",\n \"name\": \"name\",\n \"tags\": [\n \"tag\"\n ],\n \"unit\": \"unit\"\n }\n ],\n \"name\": \"name\",\n \"sequence\": 1,\n \"step_name\": \"step_name\",\n \"tags\": [\n \"tag\"\n ],\n \"words\": {\n \"person_counting_name\": \"person_counting_name\",\n \"plural_noun_name\": \"plural_noun_name\",\n \"rate_name\": \"rate_name\",\n \"singular_noun_name\": \"singular_noun_name\",\n \"verb_name\": \"verb_name\"\n }\n}"
response = http.request(request)
puts response.read_body{
"apps": [
{
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"description": "<string>",
"id": "<string>",
"name": "<string>",
"type": {
"name": "<string>"
}
}
],
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"description": "<string>",
"flow_path": "<string>",
"flow_step_id": "<string>",
"icon_color": "<string>",
"icon_type": "<string>",
"metrics": [
{
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"description": "<string>",
"expression": "<string>",
"id": "<string>",
"name": "<string>",
"tags": [
"<string>"
],
"unit": "<string>"
}
],
"name": "<string>",
"sequence": 123,
"step_name": "<string>",
"tags": [
"<string>"
],
"words": {
"person_counting_name": "<string>",
"plural_noun_name": "<string>",
"rate_name": "<string>",
"singular_noun_name": "<string>",
"verb_name": "<string>"
}
}Authorizations
HEADERQUERYCOOKIE
Body
application/json
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/flow-steps request.
Show child attributes
Show child attributes
flow_path
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
Choose between static or dynamic flow path
icon_color
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
Choose between static or dynamic icon color
icon_type
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
Choose between static or dynamic icon type
Show child attributes
Show child attributes
Choose between static or dynamic name
sequence
Static Value · numberBuildtime - Handlebars · stringBuildtime - Javascript · string
required
Choose between static or dynamic sequence
step_name
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
Choose between static or dynamic step name
Choose between static or dynamic tags
Show child attributes
Show child attributes
Choose between static or dynamic description
Show child attributes
Show child attributes
Response
Successful response
Stored campaign flow step definition. Fields flow_path, sequence, step_name, icon_type, tags, name, icon_color, and description are unevaluated and appear in buildtime-evaluatable form.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
description
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
flow_path
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
The flow path as configured: a literal value, or an expression (type:string) when defined dynamically.
icon_color
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
The icon color as configured: a literal value, or an expression (type:string) when defined dynamically.
icon_type
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
The icon type as configured: a literal value, or an expression (type:string) when defined dynamically.
Show child attributes
Show child attributes
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
sequence
Static Value · numberBuildtime - Handlebars · stringBuildtime - Javascript · string
required
The sequence as configured: a literal value, or an expression (type:string) when defined dynamically.
step_name
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
The step name as configured: a literal value, or an expression (type:string) when defined dynamically.
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
Show child attributes
Show child attributes
⌘I