Create an earn-reward action
curl --request POST \
--url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards \
--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": {}
},
"enabled": true,
"event_time": "2025-10-24T09:00:00.000Z",
"extra_data": {
"extra_data_key": {}
},
"quality": "ALWAYS",
"reward_action_id": "reward_action_id",
"reward_name": "reward_name",
"reward_supplier_id": {},
"slots": [
"slot"
],
"tags": [
"tag"
],
"value_of_event_being_rewarded": {}
}
'import requests
url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards"
payload = {
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"data": { "data_key": {} },
"enabled": True,
"event_time": "2025-10-24T09:00:00.000Z",
"extra_data": { "extra_data_key": {} },
"quality": "ALWAYS",
"reward_action_id": "reward_action_id",
"reward_name": "reward_name",
"reward_supplier_id": {},
"slots": ["slot"],
"tags": ["tag"],
"value_of_event_being_rewarded": {}
}
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: {}},
enabled: true,
event_time: '2025-10-24T09:00:00.000Z',
extra_data: {extra_data_key: {}},
quality: 'ALWAYS',
reward_action_id: 'reward_action_id',
reward_name: 'reward_name',
reward_supplier_id: {},
slots: ['slot'],
tags: ['tag'],
value_of_event_being_rewarded: {}
})
};
fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards', 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/earn-rewards",
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' => [
]
],
'enabled' => true,
'event_time' => '2025-10-24T09:00:00.000Z',
'extra_data' => [
'extra_data_key' => [
]
],
'quality' => 'ALWAYS',
'reward_action_id' => 'reward_action_id',
'reward_name' => 'reward_name',
'reward_supplier_id' => [
],
'slots' => [
'slot'
],
'tags' => [
'tag'
],
'value_of_event_being_rewarded' => [
]
]),
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/earn-rewards"
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 \"enabled\": true,\n \"event_time\": \"2025-10-24T09:00:00.000Z\",\n \"extra_data\": {\n \"extra_data_key\": {}\n },\n \"quality\": \"ALWAYS\",\n \"reward_action_id\": \"reward_action_id\",\n \"reward_name\": \"reward_name\",\n \"reward_supplier_id\": {},\n \"slots\": [\n \"slot\"\n ],\n \"tags\": [\n \"tag\"\n ],\n \"value_of_event_being_rewarded\": {}\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/earn-rewards")
.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 \"enabled\": true,\n \"event_time\": \"2025-10-24T09:00:00.000Z\",\n \"extra_data\": {\n \"extra_data_key\": {}\n },\n \"quality\": \"ALWAYS\",\n \"reward_action_id\": \"reward_action_id\",\n \"reward_name\": \"reward_name\",\n \"reward_supplier_id\": {},\n \"slots\": [\n \"slot\"\n ],\n \"tags\": [\n \"tag\"\n ],\n \"value_of_event_being_rewarded\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards")
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 \"enabled\": true,\n \"event_time\": \"2025-10-24T09:00:00.000Z\",\n \"extra_data\": {\n \"extra_data_key\": {}\n },\n \"quality\": \"ALWAYS\",\n \"reward_action_id\": \"reward_action_id\",\n \"reward_name\": \"reward_name\",\n \"reward_supplier_id\": {},\n \"slots\": [\n \"slot\"\n ],\n \"tags\": [\n \"tag\"\n ],\n \"value_of_event_being_rewarded\": {}\n}"
response = http.request(request)
puts response.read_body{
"action_id": "<string>",
"action_type": "EARN_REWARD",
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"enabled": true,
"data": {},
"event_time": "2025-10-24T09:00:00.000Z",
"extra_data": {},
"reward_action_id": "<string>",
"reward_name": "<string>",
"reward_supplier_id": "<string>",
"slots": [
"<string>"
],
"tags": [
"<string>"
],
"value_of_event_being_rewarded": {}
}Campaign Controllers Actions
Create an earn-reward action
Adds an earn-reward action to the specified campaign controller. When the controller’s triggers fire, this action earns (issues) a new reward for the participant through the configured reward supplier. Returns the created earn-reward action with its server-assigned id.
POST
/
v2
/
campaigns
/
{campaignId}
{version}
/
controllers
/
{controllerId}
/
actions
/
earn-rewards
Create an earn-reward action
curl --request POST \
--url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards \
--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": {}
},
"enabled": true,
"event_time": "2025-10-24T09:00:00.000Z",
"extra_data": {
"extra_data_key": {}
},
"quality": "ALWAYS",
"reward_action_id": "reward_action_id",
"reward_name": "reward_name",
"reward_supplier_id": {},
"slots": [
"slot"
],
"tags": [
"tag"
],
"value_of_event_being_rewarded": {}
}
'import requests
url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards"
payload = {
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"data": { "data_key": {} },
"enabled": True,
"event_time": "2025-10-24T09:00:00.000Z",
"extra_data": { "extra_data_key": {} },
"quality": "ALWAYS",
"reward_action_id": "reward_action_id",
"reward_name": "reward_name",
"reward_supplier_id": {},
"slots": ["slot"],
"tags": ["tag"],
"value_of_event_being_rewarded": {}
}
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: {}},
enabled: true,
event_time: '2025-10-24T09:00:00.000Z',
extra_data: {extra_data_key: {}},
quality: 'ALWAYS',
reward_action_id: 'reward_action_id',
reward_name: 'reward_name',
reward_supplier_id: {},
slots: ['slot'],
tags: ['tag'],
value_of_event_being_rewarded: {}
})
};
fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards', 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/earn-rewards",
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' => [
]
],
'enabled' => true,
'event_time' => '2025-10-24T09:00:00.000Z',
'extra_data' => [
'extra_data_key' => [
]
],
'quality' => 'ALWAYS',
'reward_action_id' => 'reward_action_id',
'reward_name' => 'reward_name',
'reward_supplier_id' => [
],
'slots' => [
'slot'
],
'tags' => [
'tag'
],
'value_of_event_being_rewarded' => [
]
]),
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/earn-rewards"
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 \"enabled\": true,\n \"event_time\": \"2025-10-24T09:00:00.000Z\",\n \"extra_data\": {\n \"extra_data_key\": {}\n },\n \"quality\": \"ALWAYS\",\n \"reward_action_id\": \"reward_action_id\",\n \"reward_name\": \"reward_name\",\n \"reward_supplier_id\": {},\n \"slots\": [\n \"slot\"\n ],\n \"tags\": [\n \"tag\"\n ],\n \"value_of_event_being_rewarded\": {}\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/earn-rewards")
.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 \"enabled\": true,\n \"event_time\": \"2025-10-24T09:00:00.000Z\",\n \"extra_data\": {\n \"extra_data_key\": {}\n },\n \"quality\": \"ALWAYS\",\n \"reward_action_id\": \"reward_action_id\",\n \"reward_name\": \"reward_name\",\n \"reward_supplier_id\": {},\n \"slots\": [\n \"slot\"\n ],\n \"tags\": [\n \"tag\"\n ],\n \"value_of_event_being_rewarded\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards")
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 \"enabled\": true,\n \"event_time\": \"2025-10-24T09:00:00.000Z\",\n \"extra_data\": {\n \"extra_data_key\": {}\n },\n \"quality\": \"ALWAYS\",\n \"reward_action_id\": \"reward_action_id\",\n \"reward_name\": \"reward_name\",\n \"reward_supplier_id\": {},\n \"slots\": [\n \"slot\"\n ],\n \"tags\": [\n \"tag\"\n ],\n \"value_of_event_being_rewarded\": {}\n}"
response = http.request(request)
puts response.read_body{
"action_id": "<string>",
"action_type": "EARN_REWARD",
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"enabled": true,
"data": {},
"event_time": "2025-10-24T09:00:00.000Z",
"extra_data": {},
"reward_action_id": "<string>",
"reward_name": "<string>",
"reward_supplier_id": "<string>",
"slots": [
"<string>"
],
"tags": [
"<string>"
],
"value_of_event_being_rewarded": {}
}Authorizations
HEADERQUERYCOOKIE
Path Parameters
Pattern:
(/version/.+)?Body
application/json
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/earn-rewards request.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Choose between static or dynamic enabled
Choose between static or dynamic event time
Pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$Example:
"2025-10-24T09:00:00.000Z"
extra_data
Static Value · Static Value · objectBuildtime - Handlebars · stringBuildtime - Javascript · stringRuntime - Handlebars · stringRuntime - Javascript · string
Choose between static or dynamic extra data
Show child attributes
Show child attributes
Available options:
ALWAYS, HIGH, LOW Choose between static or dynamic reward action id
Choose between static or dynamic reward name
reward_supplier_id
Static Value · Static Value · objectBuildtime - Handlebars · stringBuildtime - Javascript · string
Choose between static or dynamic reward supplier id
slots
Static Value · string[]Buildtime - Handlebars · stringBuildtime - Javascript · stringRuntime - Handlebars · stringRuntime - Javascript · string
Choose between static or dynamic slots
tags
Static Value · string[]Buildtime - Handlebars · stringBuildtime - Javascript · stringRuntime - Handlebars · stringRuntime - Javascript · string
Choose between static or dynamic tags
value_of_event_being_rewarded
Static Value · Static Value · objectBuildtime - Handlebars · stringBuildtime - Javascript · stringRuntime - Handlebars · stringRuntime - Javascript · string
Choose between static or dynamic value of event being rewarded
Response
Successful response
Available options:
EARN_REWARD Show child attributes
Show child attributes
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
Available options:
ALWAYS, HIGH, LOW Show child attributes
Show child attributes
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
Pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$Example:
"2025-10-24T09:00:00.000Z"
extra_data
Static Value · Static Value · objectBuildtime - Handlebars · stringBuildtime - Javascript · stringRuntime - Handlebars · stringRuntime - Javascript · string
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
Show child attributes
Show child attributes
The reward action id as configured: a literal value, or an expression (type:string) when defined dynamically.
The reward name as configured: a literal value, or an expression (type:string) when defined dynamically.
reward_supplier_id
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
The reward supplier id as configured: a literal value, or an expression (type:string) when defined dynamically.
slots
Static Value · string[]Buildtime - Handlebars · stringBuildtime - Javascript · stringRuntime - Handlebars · stringRuntime - Javascript · string
The slots as configured: a literal value, or an expression (type:string) when defined dynamically.
tags
Static Value · string[]Buildtime - Handlebars · stringBuildtime - Javascript · stringRuntime - Handlebars · stringRuntime - Javascript · string
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
value_of_event_being_rewarded
Static Value · Static Value · objectBuildtime - Handlebars · stringBuildtime - Javascript · stringRuntime - Handlebars · stringRuntime - Javascript · string
The value of event being rewarded as configured: a literal value, or an expression (type:string) when defined dynamically.
⌘I