Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extole Rewards API

The Rewards API from Extole — 13 operation(s) for rewards.

Extole Rewards API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Rewards. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 14 operations across 13 paths, and defines 15 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://{brand}.extole.io.

14 operations 13 paths 15 schemas 10 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole Rewards API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as extole_token (COOKIE). An API key is passed in the header as Authorization (HEADER). An API key is passed in the query as access_token (QUERY). By default, every request must be authenticated.

Paths & Operations 14

Across 13 paths, the API surfaces 14 operations — 10 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Rewards 14
GET
/v2/rewards
List rewards
listRewards 12 params → 200400401402403415429
GET
/v2/rewards/state_summary
Get reward state summary
getRewardStateSummary 6 params → 200400401402403415429
GET
/v2/rewards/{reward_id}
Get a reward
getReward 1 param → 200400401402403415429
PUT
/v2/rewards/{reward_id}
Update a reward
updateReward 1 param body → 200400401402403415429
GET
/v2/rewards/{reward_id}/cancels
Get reward cancels
getRewardCancels 1 param → 200400401402403415429
GET
/v2/rewards/{reward_id}/fails
Get reward fails
getRewardFails 1 param → 200400401402403415429
GET
/v2/rewards/{reward_id}/fulfillments
Get reward fulfillments
getRewardFulfillments 1 param → 200400401402403415429
GET
/v2/rewards/{reward_id}/history
Get reward state history
getRewardStateHistory 1 param → 200400401402403415429
GET
/v2/rewards/{reward_id}/redeems
Get reward redeems
getRewardRedeems 1 param → 200400401402403415429
GET
/v2/rewards/{reward_id}/revokes
Get reward revokes
getRewardRevokes 1 param → 200400401402403415429
GET
/v2/rewards/{reward_id}/sends
Get reward sends
getRewardSends 1 param → 200400401402403415429
POST
/v2/rewards/{reward_id}/cancel
Cancel a reward
cancelReward 1 param body → 200400401402403415429
POST
/v2/rewards/{reward_id}/retry
Retry a reward
retryReward 1 param → 200400401402403415429
POST
/v2/rewards/{reward_id}/revoke
Revoke a reward
revokeReward 1 param body → 200400401402403415429

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are RewardResponse (22 properties), FulfilledRewardStateResponse (10 properties), RewardStateSummaryResponse (9 properties), RedeemedRewardStateResponse (8 properties). Each schema is shown below with its type and property counts.

FailedRewardStateResponse
object
4 properties 4 required
RevokedRewardStateResponse
object
4 properties 4 required
RewardStateResponse
object
5 properties 5 required
FulfilledRewardStateResponse
object
10 properties 10 required
RewardStateSummaryResponse
object
9 properties 9 required
JourneyKey
object
2 properties
RewardResponse
object
22 properties 22 required
CanceledRewardStateResponse
object
4 properties 4 required
RedeemedRewardStateResponse
object
8 properties 8 required
RevokeRewardRequest
object
1 property 1 required
RewardUpdateRequest
object
Body of a PUT /v2/rewards/{rewardid} request.
1 property
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
CancelRewardRequest
object
1 property 1 required
SentRewardStateResponse
object
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-rewards-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API