Create a campaign controller

curl --request POST \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "aliases": [
    "aliase"
  ],
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "data": [
    {
      "component_ids": [
        "component_id"
      ],
      "component_references": [
        {
          "component_id": "component_id",
          "socket_names": [
            "socket_name"
          ]
        }
      ],
      "default_value": {},
      "dimension": true,
      "enabled": true,
      "key_type": "NONE",
      "name": "name",
      "persist_types": [
        "JOURNEY"
      ],
      "scope": "CLIENT",
      "value": {}
    }
  ],
  "enabled": true,
  "enabled_on_states": [
    "ARCHIVED"
  ],
  "journey_names": [
    "journey_name"
  ],
  "name": "name",
  "scope": "CLIENT",
  "selectors": [
    "BEST_REFERRAL"
  ],
  "send_policy": "ALL",
  "step_builder": {},
  "type": "CONTROLLER"
}
'

import requests

url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers"

payload = {
    "aliases": ["aliase"],
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "data": [
        {
            "component_ids": ["component_id"],
            "component_references": [
                {
                    "component_id": "component_id",
                    "socket_names": ["socket_name"]
                }
            ],
            "default_value": {},
            "dimension": True,
            "enabled": True,
            "key_type": "NONE",
            "name": "name",
            "persist_types": ["JOURNEY"],
            "scope": "CLIENT",
            "value": {}
        }
    ],
    "enabled": True,
    "enabled_on_states": ["ARCHIVED"],
    "journey_names": ["journey_name"],
    "name": "name",
    "scope": "CLIENT",
    "selectors": ["BEST_REFERRAL"],
    "send_policy": "ALL",
    "step_builder": {},
    "type": "CONTROLLER"
}
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({
    aliases: ['aliase'],
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    data: [
      {
        component_ids: ['component_id'],
        component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
        default_value: {},
        dimension: true,
        enabled: true,
        key_type: 'NONE',
        name: 'name',
        persist_types: ['JOURNEY'],
        scope: 'CLIENT',
        value: {}
      }
    ],
    enabled: true,
    enabled_on_states: ['ARCHIVED'],
    journey_names: ['journey_name'],
    name: 'name',
    scope: 'CLIENT',
    selectors: ['BEST_REFERRAL'],
    send_policy: 'ALL',
    step_builder: {},
    type: 'CONTROLLER'
  })
};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers', 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}/controllers",
  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([
    'aliases' => [
        'aliase'
    ],
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'data' => [
        [
                'component_ids' => [
                                'component_id'
                ],
                'component_references' => [
                                [
                                                                'component_id' => 'component_id',
                                                                'socket_names' => [
                                                                                                                                'socket_name'
                                                                ]
                                ]
                ],
                'default_value' => [
                                
                ],
                'dimension' => true,
                'enabled' => true,
                'key_type' => 'NONE',
                'name' => 'name',
                'persist_types' => [
                                'JOURNEY'
                ],
                'scope' => 'CLIENT',
                'value' => [
                                
                ]
        ]
    ],
    'enabled' => true,
    'enabled_on_states' => [
        'ARCHIVED'
    ],
    'journey_names' => [
        'journey_name'
    ],
    'name' => 'name',
    'scope' => 'CLIENT',
    'selectors' => [
        'BEST_REFERRAL'
    ],
    'send_policy' => 'ALL',
    'step_builder' => [
        
    ],
    'type' => 'CONTROLLER'
  ]),
  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}/controllers"

	payload := strings.NewReader("{\n  \"aliases\": [\n    \"aliase\"\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  \"data\": [\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      \"default_value\": {},\n      \"dimension\": true,\n      \"enabled\": true,\n      \"key_type\": \"NONE\",\n      \"name\": \"name\",\n      \"persist_types\": [\n        \"JOURNEY\"\n      ],\n      \"scope\": \"CLIENT\",\n      \"value\": {}\n    }\n  ],\n  \"enabled\": true,\n  \"enabled_on_states\": [\n    \"ARCHIVED\"\n  ],\n  \"journey_names\": [\n    \"journey_name\"\n  ],\n  \"name\": \"name\",\n  \"scope\": \"CLIENT\",\n  \"selectors\": [\n    \"BEST_REFERRAL\"\n  ],\n  \"send_policy\": \"ALL\",\n  \"step_builder\": {},\n  \"type\": \"CONTROLLER\"\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}/controllers")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"aliases\": [\n    \"aliase\"\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  \"data\": [\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      \"default_value\": {},\n      \"dimension\": true,\n      \"enabled\": true,\n      \"key_type\": \"NONE\",\n      \"name\": \"name\",\n      \"persist_types\": [\n        \"JOURNEY\"\n      ],\n      \"scope\": \"CLIENT\",\n      \"value\": {}\n    }\n  ],\n  \"enabled\": true,\n  \"enabled_on_states\": [\n    \"ARCHIVED\"\n  ],\n  \"journey_names\": [\n    \"journey_name\"\n  ],\n  \"name\": \"name\",\n  \"scope\": \"CLIENT\",\n  \"selectors\": [\n    \"BEST_REFERRAL\"\n  ],\n  \"send_policy\": \"ALL\",\n  \"step_builder\": {},\n  \"type\": \"CONTROLLER\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers")

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  \"aliases\": [\n    \"aliase\"\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  \"data\": [\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      \"default_value\": {},\n      \"dimension\": true,\n      \"enabled\": true,\n      \"key_type\": \"NONE\",\n      \"name\": \"name\",\n      \"persist_types\": [\n        \"JOURNEY\"\n      ],\n      \"scope\": \"CLIENT\",\n      \"value\": {}\n    }\n  ],\n  \"enabled\": true,\n  \"enabled_on_states\": [\n    \"ARCHIVED\"\n  ],\n  \"journey_names\": [\n    \"journey_name\"\n  ],\n  \"name\": \"name\",\n  \"scope\": \"CLIENT\",\n  \"selectors\": [\n    \"BEST_REFERRAL\"\n  ],\n  \"send_policy\": \"ALL\",\n  \"step_builder\": {},\n  \"type\": \"CONTROLLER\"\n}"

response = http.request(request)
puts response.read_body

{
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "created_date": "2025-10-24T02:00:00-07:00",
  "data": [
    {
      "component_ids": [
        "<string>"
      ],
      "component_references": [
        {
          "component_id": "<string>",
          "socket_names": [
            "<string>"
          ]
        }
      ],
      "default_value": {},
      "dimension": true,
      "enabled": true,
      "id": "<string>",
      "name": "<string>",
      "persist_types": [],
      "value": {}
    }
  ],
  "enabled": true,
  "id": "<string>",
  "step_builder": {},
  "triggers": [
    {
      "component_ids": [
        "<string>"
      ],
      "component_references": [
        {
          "component_id": "<string>",
          "socket_names": [
            "<string>"
          ]
        }
      ],
      "enabled": true,
      "negated": true,
      "parent_trigger_group_name": "<string>",
      "trigger_description": "<string>",
      "trigger_id": "<string>",
      "trigger_name": "<string>",
      "trigger_type": "ACCESS",
      "trusted_scopes": []
    }
  ],
  "type": "CONTROLLER",
  "updated_date": "2025-10-24T02:00:00-07:00",
  "actions": [
    {
      "action_id": "<string>",
      "action_type": "APPROVE",
      "component_ids": [
        "<string>"
      ],
      "component_references": [
        {
          "component_id": "<string>",
          "socket_names": [
            "<string>"
          ]
        }
      ],
      "enabled": true,
      "cause_type": "<string>",
      "event_type": "<string>",
      "force": "<string>",
      "legacy_action_id": "<string>",
      "note": "<string>",
      "partner_event_id": "<string>",
      "polling_id": "<string>",
      "polling_name": "<string>",
      "reward_tags": [
        "<string>"
      ]
    }
  ],
  "aliases": [
    "<string>"
  ],
  "controller_id": "<string>",
  "enabled_on_states": [],
  "journey_names": [
    "<string>"
  ],
  "name": "<string>",
  "selectors": []
}

POST

campaigns

{campaignId}

{version}

controllers

Create a campaign controller

curl --request POST \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "aliases": [
    "aliase"
  ],
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "data": [
    {
      "component_ids": [
        "component_id"
      ],
      "component_references": [
        {
          "component_id": "component_id",
          "socket_names": [
            "socket_name"
          ]
        }
      ],
      "default_value": {},
      "dimension": true,
      "enabled": true,
      "key_type": "NONE",
      "name": "name",
      "persist_types": [
        "JOURNEY"
      ],
      "scope": "CLIENT",
      "value": {}
    }
  ],
  "enabled": true,
  "enabled_on_states": [
    "ARCHIVED"
  ],
  "journey_names": [
    "journey_name"
  ],
  "name": "name",
  "scope": "CLIENT",
  "selectors": [
    "BEST_REFERRAL"
  ],
  "send_policy": "ALL",
  "step_builder": {},
  "type": "CONTROLLER"
}
'

import requests

url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers"

payload = {
    "aliases": ["aliase"],
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "data": [
        {
            "component_ids": ["component_id"],
            "component_references": [
                {
                    "component_id": "component_id",
                    "socket_names": ["socket_name"]
                }
            ],
            "default_value": {},
            "dimension": True,
            "enabled": True,
            "key_type": "NONE",
            "name": "name",
            "persist_types": ["JOURNEY"],
            "scope": "CLIENT",
            "value": {}
        }
    ],
    "enabled": True,
    "enabled_on_states": ["ARCHIVED"],
    "journey_names": ["journey_name"],
    "name": "name",
    "scope": "CLIENT",
    "selectors": ["BEST_REFERRAL"],
    "send_policy": "ALL",
    "step_builder": {},
    "type": "CONTROLLER"
}
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({
    aliases: ['aliase'],
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    data: [
      {
        component_ids: ['component_id'],
        component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
        default_value: {},
        dimension: true,
        enabled: true,
        key_type: 'NONE',
        name: 'name',
        persist_types: ['JOURNEY'],
        scope: 'CLIENT',
        value: {}
      }
    ],
    enabled: true,
    enabled_on_states: ['ARCHIVED'],
    journey_names: ['journey_name'],
    name: 'name',
    scope: 'CLIENT',
    selectors: ['BEST_REFERRAL'],
    send_policy: 'ALL',
    step_builder: {},
    type: 'CONTROLLER'
  })
};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers', 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}/controllers",
  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([
    'aliases' => [
        'aliase'
    ],
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'data' => [
        [
                'component_ids' => [
                                'component_id'
                ],
                'component_references' => [
                                [
                                                                'component_id' => 'component_id',
                                                                'socket_names' => [
                                                                                                                                'socket_name'
                                                                ]
                                ]
                ],
                'default_value' => [
                                
                ],
                'dimension' => true,
                'enabled' => true,
                'key_type' => 'NONE',
                'name' => 'name',
                'persist_types' => [
                                'JOURNEY'
                ],
                'scope' => 'CLIENT',
                'value' => [
                                
                ]
        ]
    ],
    'enabled' => true,
    'enabled_on_states' => [
        'ARCHIVED'
    ],
    'journey_names' => [
        'journey_name'
    ],
    'name' => 'name',
    'scope' => 'CLIENT',
    'selectors' => [
        'BEST_REFERRAL'
    ],
    'send_policy' => 'ALL',
    'step_builder' => [
        
    ],
    'type' => 'CONTROLLER'
  ]),
  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}/controllers"

	payload := strings.NewReader("{\n  \"aliases\": [\n    \"aliase\"\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  \"data\": [\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      \"default_value\": {},\n      \"dimension\": true,\n      \"enabled\": true,\n      \"key_type\": \"NONE\",\n      \"name\": \"name\",\n      \"persist_types\": [\n        \"JOURNEY\"\n      ],\n      \"scope\": \"CLIENT\",\n      \"value\": {}\n    }\n  ],\n  \"enabled\": true,\n  \"enabled_on_states\": [\n    \"ARCHIVED\"\n  ],\n  \"journey_names\": [\n    \"journey_name\"\n  ],\n  \"name\": \"name\",\n  \"scope\": \"CLIENT\",\n  \"selectors\": [\n    \"BEST_REFERRAL\"\n  ],\n  \"send_policy\": \"ALL\",\n  \"step_builder\": {},\n  \"type\": \"CONTROLLER\"\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}/controllers")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"aliases\": [\n    \"aliase\"\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  \"data\": [\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      \"default_value\": {},\n      \"dimension\": true,\n      \"enabled\": true,\n      \"key_type\": \"NONE\",\n      \"name\": \"name\",\n      \"persist_types\": [\n        \"JOURNEY\"\n      ],\n      \"scope\": \"CLIENT\",\n      \"value\": {}\n    }\n  ],\n  \"enabled\": true,\n  \"enabled_on_states\": [\n    \"ARCHIVED\"\n  ],\n  \"journey_names\": [\n    \"journey_name\"\n  ],\n  \"name\": \"name\",\n  \"scope\": \"CLIENT\",\n  \"selectors\": [\n    \"BEST_REFERRAL\"\n  ],\n  \"send_policy\": \"ALL\",\n  \"step_builder\": {},\n  \"type\": \"CONTROLLER\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers")

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  \"aliases\": [\n    \"aliase\"\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  \"data\": [\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      \"default_value\": {},\n      \"dimension\": true,\n      \"enabled\": true,\n      \"key_type\": \"NONE\",\n      \"name\": \"name\",\n      \"persist_types\": [\n        \"JOURNEY\"\n      ],\n      \"scope\": \"CLIENT\",\n      \"value\": {}\n    }\n  ],\n  \"enabled\": true,\n  \"enabled_on_states\": [\n    \"ARCHIVED\"\n  ],\n  \"journey_names\": [\n    \"journey_name\"\n  ],\n  \"name\": \"name\",\n  \"scope\": \"CLIENT\",\n  \"selectors\": [\n    \"BEST_REFERRAL\"\n  ],\n  \"send_policy\": \"ALL\",\n  \"step_builder\": {},\n  \"type\": \"CONTROLLER\"\n}"

response = http.request(request)
puts response.read_body

{
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "created_date": "2025-10-24T02:00:00-07:00",
  "data": [
    {
      "component_ids": [
        "<string>"
      ],
      "component_references": [
        {
          "component_id": "<string>",
          "socket_names": [
            "<string>"
          ]
        }
      ],
      "default_value": {},
      "dimension": true,
      "enabled": true,
      "id": "<string>",
      "name": "<string>",
      "persist_types": [],
      "value": {}
    }
  ],
  "enabled": true,
  "id": "<string>",
  "step_builder": {},
  "triggers": [
    {
      "component_ids": [
        "<string>"
      ],
      "component_references": [
        {
          "component_id": "<string>",
          "socket_names": [
            "<string>"
          ]
        }
      ],
      "enabled": true,
      "negated": true,
      "parent_trigger_group_name": "<string>",
      "trigger_description": "<string>",
      "trigger_id": "<string>",
      "trigger_name": "<string>",
      "trigger_type": "ACCESS",
      "trusted_scopes": []
    }
  ],
  "type": "CONTROLLER",
  "updated_date": "2025-10-24T02:00:00-07:00",
  "actions": [
    {
      "action_id": "<string>",
      "action_type": "APPROVE",
      "component_ids": [
        "<string>"
      ],
      "component_references": [
        {
          "component_id": "<string>",
          "socket_names": [
            "<string>"
          ]
        }
      ],
      "enabled": true,
      "cause_type": "<string>",
      "event_type": "<string>",
      "force": "<string>",
      "legacy_action_id": "<string>",
      "note": "<string>",
      "partner_event_id": "<string>",
      "polling_id": "<string>",
      "polling_name": "<string>",
      "reward_tags": [
        "<string>"
      ]
    }
  ],
  "aliases": [
    "<string>"
  ],
  "controller_id": "<string>",
  "enabled_on_states": [],
  "journey_names": [
    "<string>"
  ],
  "name": "<string>",
  "selectors": []
}

Authorizations

Authorization

string

header

required

Path Parameters

campaignId

string

required

version

string

required

Pattern: (/version/.+)?

Body

application/json

CONTROLLER
FRONTEND_CONTROLLER
JOURNEY_ENTRY

Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers request.

type

enum<string>

required

Available options:

CONTROLLER

name

required

Choose between static or dynamic name

component_ids

string[]

component_references

object[]

Show child attributes

enabled

Choose between static or dynamic enabled

step_builder

Choose between static or dynamic step builder

aliases

Choose between static or dynamic aliases

data

object[]

Show child attributes

enabled_on_states

Choose between static or dynamic enabled on states

Available options:

ARCHIVED,

ENDED,

LIVE,

NOT_LAUNCHED,

PAUSED,

STOPPED

journey_names

Choose between static or dynamic journey names

scope

Choose between static or dynamic scope

Available options:

CLIENT,

PRIVATE,

PUBLIC

selectors

Choose between static or dynamic selectors

Available options:

BEST_REFERRAL,

BEST_REFERRAL_SAME_PROGRAM,

MATCHING_CAMPAIGN,

TARGET

send_policy

Choose between static or dynamic send policy

Available options:

ALL,

FIRST_ONLY

Response

Successful response

CONTROLLER
FRONTEND_CONTROLLER
JOURNEY_ENTRY

Stored campaign controller definition. Fields enabled, name, scope, enabled_on_states, selectors, aliases, journey_names, send_policy, and step_builder are unevaluated and appear in buildtime-evaluatable form.

component_ids

string[]

required

component_references

object[]

required

Show child attributes

created_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

data

object[]

required

Show child attributes

enabled

required

The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.

string

required

read-only

step_builder

required

The step builder as configured: a literal value, or an expression (type:string) when defined dynamically.

triggers

required

Stored campaign controller trigger definition. Fields trigger_phase, trigger_name, parent_trigger_group_name, trigger_description, enabled, and negated are unevaluated and appear in buildtime-evaluatable form.

Show child attributes

type

enum<string>

required

Available options:

CONTROLLER

updated_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

actions

required

Stored campaign controller action definition. Field enabled is unevaluated and appears in buildtime-evaluatable form.

Show child attributes

aliases

required

The aliases as configured: a literal value, or an expression (type:string) when defined dynamically.

controller_id

string

required

enabled_on_states

required

The enabled on states as configured: a literal value, or an expression (type:string) when defined dynamically.

Available options:

ARCHIVED,

ENDED,

LIVE,

NOT_LAUNCHED,

PAUSED,

STOPPED

journey_names

required

The journey names as configured: a literal value, or an expression (type:string) when defined dynamically.

name

required

The name as configured: a literal value, or an expression (type:string) when defined dynamically.

scope

required

The scope as configured: a literal value, or an expression (type:string) when defined dynamically.

Available options:

CLIENT,

PRIVATE,

PUBLIC

selectors

required

The selectors as configured: a literal value, or an expression (type:string) when defined dynamically.

Available options:

BEST_REFERRAL,

BEST_REFERRAL_SAME_PROGRAM,

MATCHING_CAMPAIGN,

TARGET

send_policy

required

The send policy as configured: a literal value, or an expression (type:string) when defined dynamically.

Available options:

ALL,

FIRST_ONLY

List campaign controllers List built campaign controllers

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Create a campaign controller

Authorizations

Path Parameters

Body

Response