Mark custom reward fulfilled

curl --request POST \
  --url https://api.extole.io/v2/rewards/custom-reward/{reward_id}/fulfilled \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "code",
  "cost_code": "cost_code",
  "image": "https://www.extole.com/logo.png",
  "instructions": "instructions",
  "link": "https://www.extole.com/redeem-your-reward-here",
  "message": "message",
  "partner_reward_id": "partner_reward_id",
  "success": true
}
'

import requests

url = "https://api.extole.io/v2/rewards/custom-reward/{reward_id}/fulfilled"

payload = {
    "code": "code",
    "cost_code": "cost_code",
    "image": "https://www.extole.com/logo.png",
    "instructions": "instructions",
    "link": "https://www.extole.com/redeem-your-reward-here",
    "message": "message",
    "partner_reward_id": "partner_reward_id",
    "success": True
}
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({
    code: 'code',
    cost_code: 'cost_code',
    image: 'https://www.extole.com/logo.png',
    instructions: 'instructions',
    link: 'https://www.extole.com/redeem-your-reward-here',
    message: 'message',
    partner_reward_id: 'partner_reward_id',
    success: true
  })
};

fetch('https://api.extole.io/v2/rewards/custom-reward/{reward_id}/fulfilled', 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/rewards/custom-reward/{reward_id}/fulfilled",
  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([
    'code' => 'code',
    'cost_code' => 'cost_code',
    'image' => 'https://www.extole.com/logo.png',
    'instructions' => 'instructions',
    'link' => 'https://www.extole.com/redeem-your-reward-here',
    'message' => 'message',
    'partner_reward_id' => 'partner_reward_id',
    'success' => true
  ]),
  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/rewards/custom-reward/{reward_id}/fulfilled"

	payload := strings.NewReader("{\n  \"code\": \"code\",\n  \"cost_code\": \"cost_code\",\n  \"image\": \"https://www.extole.com/logo.png\",\n  \"instructions\": \"instructions\",\n  \"link\": \"https://www.extole.com/redeem-your-reward-here\",\n  \"message\": \"message\",\n  \"partner_reward_id\": \"partner_reward_id\",\n  \"success\": true\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/rewards/custom-reward/{reward_id}/fulfilled")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"code\",\n  \"cost_code\": \"cost_code\",\n  \"image\": \"https://www.extole.com/logo.png\",\n  \"instructions\": \"instructions\",\n  \"link\": \"https://www.extole.com/redeem-your-reward-here\",\n  \"message\": \"message\",\n  \"partner_reward_id\": \"partner_reward_id\",\n  \"success\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/rewards/custom-reward/{reward_id}/fulfilled")

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  \"code\": \"code\",\n  \"cost_code\": \"cost_code\",\n  \"image\": \"https://www.extole.com/logo.png\",\n  \"instructions\": \"instructions\",\n  \"link\": \"https://www.extole.com/redeem-your-reward-here\",\n  \"message\": \"message\",\n  \"partner_reward_id\": \"partner_reward_id\",\n  \"success\": true\n}"

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

{
  "action_id": "<string>",
  "campaign_id": "<string>",
  "cause_event_id": "<string>",
  "code": "<string>",
  "container": "<string>",
  "created_at": "2025-10-24T02:00:00-07:00",
  "data": {},
  "email": "<string>",
  "expires_at": "2025-10-24T02:00:00-07:00",
  "face_value": 123,
  "face_value_type": "AUD",
  "image": "https://www.extole.com/logo.png",
  "instructions": "<string>",
  "journey_key": {
    "name": "<string>",
    "value": "<string>"
  },
  "journey_name": "<string>",
  "link": "https://www.extole.com/redeem-your-reward-here",
  "partner_reward_id": "<string>",
  "partner_reward_key_type": "COUPON",
  "partner_reward_supplier_id": "<string>",
  "partner_user_id": "<string>",
  "person_id": "<string>",
  "reward_id": "<string>",
  "reward_supplier_id": "<string>",
  "root_event_id": "<string>",
  "sandbox": "<string>",
  "state": "CANCELED"
}

POST

https://api.extole.io

rewards

custom-reward

{reward_id}

fulfilled

Mark custom reward fulfilled

curl --request POST \
  --url https://api.extole.io/v2/rewards/custom-reward/{reward_id}/fulfilled \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "code",
  "cost_code": "cost_code",
  "image": "https://www.extole.com/logo.png",
  "instructions": "instructions",
  "link": "https://www.extole.com/redeem-your-reward-here",
  "message": "message",
  "partner_reward_id": "partner_reward_id",
  "success": true
}
'

import requests

url = "https://api.extole.io/v2/rewards/custom-reward/{reward_id}/fulfilled"

payload = {
    "code": "code",
    "cost_code": "cost_code",
    "image": "https://www.extole.com/logo.png",
    "instructions": "instructions",
    "link": "https://www.extole.com/redeem-your-reward-here",
    "message": "message",
    "partner_reward_id": "partner_reward_id",
    "success": True
}
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({
    code: 'code',
    cost_code: 'cost_code',
    image: 'https://www.extole.com/logo.png',
    instructions: 'instructions',
    link: 'https://www.extole.com/redeem-your-reward-here',
    message: 'message',
    partner_reward_id: 'partner_reward_id',
    success: true
  })
};

fetch('https://api.extole.io/v2/rewards/custom-reward/{reward_id}/fulfilled', 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/rewards/custom-reward/{reward_id}/fulfilled",
  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([
    'code' => 'code',
    'cost_code' => 'cost_code',
    'image' => 'https://www.extole.com/logo.png',
    'instructions' => 'instructions',
    'link' => 'https://www.extole.com/redeem-your-reward-here',
    'message' => 'message',
    'partner_reward_id' => 'partner_reward_id',
    'success' => true
  ]),
  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/rewards/custom-reward/{reward_id}/fulfilled"

	payload := strings.NewReader("{\n  \"code\": \"code\",\n  \"cost_code\": \"cost_code\",\n  \"image\": \"https://www.extole.com/logo.png\",\n  \"instructions\": \"instructions\",\n  \"link\": \"https://www.extole.com/redeem-your-reward-here\",\n  \"message\": \"message\",\n  \"partner_reward_id\": \"partner_reward_id\",\n  \"success\": true\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/rewards/custom-reward/{reward_id}/fulfilled")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"code\",\n  \"cost_code\": \"cost_code\",\n  \"image\": \"https://www.extole.com/logo.png\",\n  \"instructions\": \"instructions\",\n  \"link\": \"https://www.extole.com/redeem-your-reward-here\",\n  \"message\": \"message\",\n  \"partner_reward_id\": \"partner_reward_id\",\n  \"success\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/rewards/custom-reward/{reward_id}/fulfilled")

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  \"code\": \"code\",\n  \"cost_code\": \"cost_code\",\n  \"image\": \"https://www.extole.com/logo.png\",\n  \"instructions\": \"instructions\",\n  \"link\": \"https://www.extole.com/redeem-your-reward-here\",\n  \"message\": \"message\",\n  \"partner_reward_id\": \"partner_reward_id\",\n  \"success\": true\n}"

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

{
  "action_id": "<string>",
  "campaign_id": "<string>",
  "cause_event_id": "<string>",
  "code": "<string>",
  "container": "<string>",
  "created_at": "2025-10-24T02:00:00-07:00",
  "data": {},
  "email": "<string>",
  "expires_at": "2025-10-24T02:00:00-07:00",
  "face_value": 123,
  "face_value_type": "AUD",
  "image": "https://www.extole.com/logo.png",
  "instructions": "<string>",
  "journey_key": {
    "name": "<string>",
    "value": "<string>"
  },
  "journey_name": "<string>",
  "link": "https://www.extole.com/redeem-your-reward-here",
  "partner_reward_id": "<string>",
  "partner_reward_key_type": "COUPON",
  "partner_reward_supplier_id": "<string>",
  "partner_user_id": "<string>",
  "person_id": "<string>",
  "reward_id": "<string>",
  "reward_supplier_id": "<string>",
  "root_event_id": "<string>",
  "sandbox": "<string>",
  "state": "CANCELED"
}

Authorizations

Authorization

string

header

required

Path Parameters

reward_id

string

required

Body

application/json

code

string

The reward code, that could be used in order to redeem the reward.

cost_code

string

image

string<uri>

An image associated with the reward. E.g.: a brand image.

Example:

"https://www.extole.com/logo.png"

instructions

string

Instructions on how to redeem the reward.

link

string<uri>

A link associated with the reward. E.g.: a reward redemption link.

Example:

"https://www.extole.com/redeem-your-reward-here"

message

string

partner_reward_id

string

success

boolean

Response

Successful response

action_id

string

required

Extole action id associated with this reward.

campaign_id

string

required

Extole campaign id associated with this reward.

cause_event_id

string

required

Id of the direct cause event that triggered this reward.

code

string

required

The reward code, that could be used in order to redeem the reward.

container

string

required

Campaign container the reward belongs to.

created_at

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

Named data parameters attached to this reward.

Show child attributes

string

required

Email address of the reward recipient. Null if not available.

expires_at

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"

face_value

number

required

Monetary or point face value of the reward.

face_value_type

enum<string>

required

Unit type of the face value (e.g. POINTS, PERCENT_OFF, USD).

Available options:

AUD,

BRL,

CAD,

CNY,

EUR,

GBP,

HKD,

INR,

JPY,

KRW,

MONTH,

MXN,

NZD,

PERCENT_OFF,

POINTS,

TRY,

TWD,

USD

image

string<uri>

required

An image associated with the reward. E.g.: a brand image.

Example:

"https://www.extole.com/logo.png"

instructions

string

required

Instructions on how to redeem the reward.

journey_key

object

required

Show child attributes

journey_name

string

required

Name of the journey associated with this reward.

link

string<uri>

required

A link associated with the reward. E.g.: a reward redemption link.

Example:

"https://www.extole.com/redeem-your-reward-here"

partner_reward_id

string

required

Partner-assigned identifier for this reward. Null if not yet assigned.

partner_reward_key_type

enum<string>

required

Type of key used to identify the reward at the partner's system.

Available options:

COUPON,

ID,

LINK

partner_reward_supplier_id

string

required

Partner-assigned identifier for the reward supplier. Null if not provided.

partner_user_id

string

required

Partner's identifier for the person. Null if not provided.

person_id

string

required

Extole person id of the reward recipient.

reward_id

string

required

Extole-assigned unique identifier for this reward.

reward_supplier_id

string

required

Extole reward supplier id that issued this reward.

root_event_id

string

required

Id of the root event that initiated the chain leading to this reward.

sandbox

string

required

Sandbox identifier for this reward.

state

enum<string>

required

Current lifecycle state of the reward.

Available options:

CANCELED,

EARNED,

EXPIRED,

FAILED,

FULFILLED,

REDEEMED,

REVOKED,

SENT

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Feature Specific APIs

Mark custom reward fulfilled

Authorizations

Path Parameters

Body

Response