curl --request POST \
--url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-rewards \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": {},
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"enabled": true,
"event_time": "2025-10-24T09:00:00.000Z",
"message": "message",
"partner_reward_id": "partner_reward_id",
"quality": "ALWAYS",
"reward_id": "reward_id",
"success": "success"
}
'import requests
url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-rewards"
payload = {
"amount": {},
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"enabled": True,
"event_time": "2025-10-24T09:00:00.000Z",
"message": "message",
"partner_reward_id": "partner_reward_id",
"quality": "ALWAYS",
"reward_id": "reward_id",
"success": "success"
}
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({
amount: {},
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
enabled: true,
event_time: '2025-10-24T09:00:00.000Z',
message: 'message',
partner_reward_id: 'partner_reward_id',
quality: 'ALWAYS',
reward_id: 'reward_id',
success: 'success'
})
};
fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-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/fulfill-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([
'amount' => [
],
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'enabled' => true,
'event_time' => '2025-10-24T09:00:00.000Z',
'message' => 'message',
'partner_reward_id' => 'partner_reward_id',
'quality' => 'ALWAYS',
'reward_id' => 'reward_id',
'success' => 'success'
]),
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/fulfill-rewards"
payload := strings.NewReader("{\n \"amount\": {},\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 \"enabled\": true,\n \"event_time\": \"2025-10-24T09:00:00.000Z\",\n \"message\": \"message\",\n \"partner_reward_id\": \"partner_reward_id\",\n \"quality\": \"ALWAYS\",\n \"reward_id\": \"reward_id\",\n \"success\": \"success\"\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/fulfill-rewards")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": {},\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 \"enabled\": true,\n \"event_time\": \"2025-10-24T09:00:00.000Z\",\n \"message\": \"message\",\n \"partner_reward_id\": \"partner_reward_id\",\n \"quality\": \"ALWAYS\",\n \"reward_id\": \"reward_id\",\n \"success\": \"success\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-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 \"amount\": {},\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 \"enabled\": true,\n \"event_time\": \"2025-10-24T09:00:00.000Z\",\n \"message\": \"message\",\n \"partner_reward_id\": \"partner_reward_id\",\n \"quality\": \"ALWAYS\",\n \"reward_id\": \"reward_id\",\n \"success\": \"success\"\n}"
response = http.request(request)
puts response.read_body{
"action_id": "<string>",
"action_type": "FULFILL_REWARD",
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"enabled": true,
"event_time": "2025-10-24T09:00:00.000Z",
"message": "<string>",
"partner_reward_id": "<string>",
"reward_id": "<string>",
"success": "<string>"
}Create a fulfill-reward action
Adds a fulfill-reward action to the specified campaign controller. When the controller’s triggers fire, this action fulfills a previously earned reward, triggering downstream fulfilment logic. Returns the created fulfill-reward action with its server-assigned id.
curl --request POST \
--url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-rewards \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": {},
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"enabled": true,
"event_time": "2025-10-24T09:00:00.000Z",
"message": "message",
"partner_reward_id": "partner_reward_id",
"quality": "ALWAYS",
"reward_id": "reward_id",
"success": "success"
}
'import requests
url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-rewards"
payload = {
"amount": {},
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"enabled": True,
"event_time": "2025-10-24T09:00:00.000Z",
"message": "message",
"partner_reward_id": "partner_reward_id",
"quality": "ALWAYS",
"reward_id": "reward_id",
"success": "success"
}
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({
amount: {},
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
enabled: true,
event_time: '2025-10-24T09:00:00.000Z',
message: 'message',
partner_reward_id: 'partner_reward_id',
quality: 'ALWAYS',
reward_id: 'reward_id',
success: 'success'
})
};
fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-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/fulfill-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([
'amount' => [
],
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'enabled' => true,
'event_time' => '2025-10-24T09:00:00.000Z',
'message' => 'message',
'partner_reward_id' => 'partner_reward_id',
'quality' => 'ALWAYS',
'reward_id' => 'reward_id',
'success' => 'success'
]),
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/fulfill-rewards"
payload := strings.NewReader("{\n \"amount\": {},\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 \"enabled\": true,\n \"event_time\": \"2025-10-24T09:00:00.000Z\",\n \"message\": \"message\",\n \"partner_reward_id\": \"partner_reward_id\",\n \"quality\": \"ALWAYS\",\n \"reward_id\": \"reward_id\",\n \"success\": \"success\"\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/fulfill-rewards")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": {},\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 \"enabled\": true,\n \"event_time\": \"2025-10-24T09:00:00.000Z\",\n \"message\": \"message\",\n \"partner_reward_id\": \"partner_reward_id\",\n \"quality\": \"ALWAYS\",\n \"reward_id\": \"reward_id\",\n \"success\": \"success\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-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 \"amount\": {},\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 \"enabled\": true,\n \"event_time\": \"2025-10-24T09:00:00.000Z\",\n \"message\": \"message\",\n \"partner_reward_id\": \"partner_reward_id\",\n \"quality\": \"ALWAYS\",\n \"reward_id\": \"reward_id\",\n \"success\": \"success\"\n}"
response = http.request(request)
puts response.read_body{
"action_id": "<string>",
"action_type": "FULFILL_REWARD",
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"enabled": true,
"event_time": "2025-10-24T09:00:00.000Z",
"message": "<string>",
"partner_reward_id": "<string>",
"reward_id": "<string>",
"success": "<string>"
}Authorizations
Path Parameters
(/version/.+)?Body
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/fulfill-rewards request.
Choose between static or dynamic amount
Show child attributes
Show child attributes
Choose between static or dynamic enabled
Choose between static or dynamic event time
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$"2025-10-24T09:00:00.000Z"
Choose between static or dynamic partner reward id
ALWAYS, HIGH, LOW Response
Successful response
FULFILL_REWARD Show child attributes
Show child attributes
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
ALWAYS, HIGH, LOW The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$"2025-10-24T09:00:00.000Z"
The partner reward id as configured: a literal value, or an expression (type:string) when defined dynamically.
