List all campaign controller actions

curl --request GET \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions \
  --header 'Authorization: <api-key>'

import requests

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

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions', 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/{controllerId}/actions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$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.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

[
  {
    "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>"
    ]
  }
]

GET

campaigns

{campaignId}

{version}

controllers

{controllerId}

actions

List all campaign controller actions

curl --request GET \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions \
  --header 'Authorization: <api-key>'

import requests

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

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions', 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/{controllerId}/actions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$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.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

[
  {
    "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>"
    ]
  }
]

Authorizations

Authorization

string

header

required

Path Parameters

campaignId

string

required

version

string

required

Pattern: (/version/.+)?

controllerId

string

required

Response

Successful response

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

action_id

string

required

action_type

enum<string>

required

Available options:

APPROVE

component_ids

string[]

required

component_references

object[]

required

Show child attributes

enabled

required

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

quality

enum<string>

required

Available options:

ALWAYS,

HIGH,

LOW

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

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

List built campaign controllers Get an approve action

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

List all campaign controller actions

Authorizations

Path Parameters

Response