Create a schedule action

curl --request POST \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/schedules \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "data": {
    "data_key": {}
  },
  "dates": [
    "2025-10-24T02:00:00-07:00"
  ],
  "delays": [
    "PT42S"
  ],
  "enabled": true,
  "extra_data": {
    "extra_data_key": {}
  },
  "force": true,
  "quality": "ALWAYS",
  "schedule_name": "schedule_name"
}
'

import requests

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

payload = {
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "data": { "data_key": {} },
    "dates": ["2025-10-24T02:00:00-07:00"],
    "delays": ["PT42S"],
    "enabled": True,
    "extra_data": { "extra_data_key": {} },
    "force": True,
    "quality": "ALWAYS",
    "schedule_name": "schedule_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({
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    data: {data_key: {}},
    dates: ['2025-10-24T02:00:00-07:00'],
    delays: ['PT42S'],
    enabled: true,
    extra_data: {extra_data_key: {}},
    force: true,
    quality: 'ALWAYS',
    schedule_name: 'schedule_name'
  })
};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/schedules', 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/schedules",
  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([
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'data' => [
        'data_key' => [
                
        ]
    ],
    'dates' => [
        '2025-10-24T02:00:00-07:00'
    ],
    'delays' => [
        'PT42S'
    ],
    'enabled' => true,
    'extra_data' => [
        'extra_data_key' => [
                
        ]
    ],
    'force' => true,
    'quality' => 'ALWAYS',
    'schedule_name' => 'schedule_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}/controllers/{controllerId}/actions/schedules"

	payload := strings.NewReader("{\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    \"data_key\": {}\n  },\n  \"dates\": [\n    \"2025-10-24T02:00:00-07:00\"\n  ],\n  \"delays\": [\n    \"PT42S\"\n  ],\n  \"enabled\": true,\n  \"extra_data\": {\n    \"extra_data_key\": {}\n  },\n  \"force\": true,\n  \"quality\": \"ALWAYS\",\n  \"schedule_name\": \"schedule_name\"\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/{controllerId}/actions/schedules")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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    \"data_key\": {}\n  },\n  \"dates\": [\n    \"2025-10-24T02:00:00-07:00\"\n  ],\n  \"delays\": [\n    \"PT42S\"\n  ],\n  \"enabled\": true,\n  \"extra_data\": {\n    \"extra_data_key\": {}\n  },\n  \"force\": true,\n  \"quality\": \"ALWAYS\",\n  \"schedule_name\": \"schedule_name\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"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    \"data_key\": {}\n  },\n  \"dates\": [\n    \"2025-10-24T02:00:00-07:00\"\n  ],\n  \"delays\": [\n    \"PT42S\"\n  ],\n  \"enabled\": true,\n  \"extra_data\": {\n    \"extra_data_key\": {}\n  },\n  \"force\": true,\n  \"quality\": \"ALWAYS\",\n  \"schedule_name\": \"schedule_name\"\n}"

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

{
  "action_id": "<string>",
  "action_type": "SCHEDULE",
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "enabled": true,
  "data": {},
  "dates": [
    "2025-10-24T02:00:00-07:00"
  ],
  "delays": [
    "PT42S"
  ],
  "extra_data": {},
  "force": true,
  "schedule_name": "<string>"
}

POST

campaigns

{campaignId}

{version}

controllers

{controllerId}

actions

schedules

Create a schedule action

curl --request POST \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/schedules \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "data": {
    "data_key": {}
  },
  "dates": [
    "2025-10-24T02:00:00-07:00"
  ],
  "delays": [
    "PT42S"
  ],
  "enabled": true,
  "extra_data": {
    "extra_data_key": {}
  },
  "force": true,
  "quality": "ALWAYS",
  "schedule_name": "schedule_name"
}
'

import requests

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

payload = {
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "data": { "data_key": {} },
    "dates": ["2025-10-24T02:00:00-07:00"],
    "delays": ["PT42S"],
    "enabled": True,
    "extra_data": { "extra_data_key": {} },
    "force": True,
    "quality": "ALWAYS",
    "schedule_name": "schedule_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({
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    data: {data_key: {}},
    dates: ['2025-10-24T02:00:00-07:00'],
    delays: ['PT42S'],
    enabled: true,
    extra_data: {extra_data_key: {}},
    force: true,
    quality: 'ALWAYS',
    schedule_name: 'schedule_name'
  })
};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/schedules', 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/schedules",
  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([
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'data' => [
        'data_key' => [
                
        ]
    ],
    'dates' => [
        '2025-10-24T02:00:00-07:00'
    ],
    'delays' => [
        'PT42S'
    ],
    'enabled' => true,
    'extra_data' => [
        'extra_data_key' => [
                
        ]
    ],
    'force' => true,
    'quality' => 'ALWAYS',
    'schedule_name' => 'schedule_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}/controllers/{controllerId}/actions/schedules"

	payload := strings.NewReader("{\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    \"data_key\": {}\n  },\n  \"dates\": [\n    \"2025-10-24T02:00:00-07:00\"\n  ],\n  \"delays\": [\n    \"PT42S\"\n  ],\n  \"enabled\": true,\n  \"extra_data\": {\n    \"extra_data_key\": {}\n  },\n  \"force\": true,\n  \"quality\": \"ALWAYS\",\n  \"schedule_name\": \"schedule_name\"\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/{controllerId}/actions/schedules")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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    \"data_key\": {}\n  },\n  \"dates\": [\n    \"2025-10-24T02:00:00-07:00\"\n  ],\n  \"delays\": [\n    \"PT42S\"\n  ],\n  \"enabled\": true,\n  \"extra_data\": {\n    \"extra_data_key\": {}\n  },\n  \"force\": true,\n  \"quality\": \"ALWAYS\",\n  \"schedule_name\": \"schedule_name\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"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    \"data_key\": {}\n  },\n  \"dates\": [\n    \"2025-10-24T02:00:00-07:00\"\n  ],\n  \"delays\": [\n    \"PT42S\"\n  ],\n  \"enabled\": true,\n  \"extra_data\": {\n    \"extra_data_key\": {}\n  },\n  \"force\": true,\n  \"quality\": \"ALWAYS\",\n  \"schedule_name\": \"schedule_name\"\n}"

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

{
  "action_id": "<string>",
  "action_type": "SCHEDULE",
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "enabled": true,
  "data": {},
  "dates": [
    "2025-10-24T02:00:00-07:00"
  ],
  "delays": [
    "PT42S"
  ],
  "extra_data": {},
  "force": true,
  "schedule_name": "<string>"
}

Authorizations

Authorization

string

header

required

Path Parameters

campaignId

string

required

version

string

required

Pattern: (/version/.+)?

controllerId

string

required

Body

application/json

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

component_ids

string[]

component_references

object[]

Show child attributes

data

object

Show child attributes

dates

Choose between static or dynamic dates

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])(\[[^\]]+\])?$

delays

Choose between static or dynamic delays

RFC 5545 duration string.

Pattern:

^[-+]?P(?:(?:[-+]?[0-9]+D)(?:T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)?|T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)$

enabled

Choose between static or dynamic enabled

extra_data

Choose between static or dynamic extra data

Show child attributes

force

boolean

quality

enum<string>

Available options:

ALWAYS,

HIGH,

LOW

schedule_name

Choose between static or dynamic schedule name

Response

Successful response

action_id

string

action_type

enum<string>

Available options:

SCHEDULE

component_ids

string[]

component_references

object[]

Show child attributes

enabled

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

quality

enum<string>

Available options:

ALWAYS,

HIGH,

LOW

data

object

Show child attributes

dates

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

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])(\[[^\]]+\])?$

delays

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

RFC 5545 duration string.

Pattern:

^[-+]?P(?:(?:[-+]?[0-9]+D)(?:T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)?|T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)$

extra_data

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

Show child attributes

force

boolean

schedule_name

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

Create a revoke-reward action Create a share-event action

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Create a schedule action

Authorizations

Path Parameters

Body

Response