Extole Reward Suppliers API
The Reward Suppliers API from Extole — 21 operation(s) for reward suppliers.
Extole Reward Suppliers API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Reward Suppliers. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 27 operations across 21 paths, and defines 144 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.
27 operations
21 paths
144 schemas
4 DELETE13 GET9 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Extole Reward Suppliers 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 27
Across 21 paths, the API surfaces 27 operations — 4 DELETE, 13 GET, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Reward Suppliers 27
POST
/v2/rewards/custom-reward/{reward_id}/failed
Mark custom reward failed
POST
/v2/rewards/custom-reward/{reward_id}/fulfilled
Mark custom reward fulfilled
POST
/v2/rewards/custom-reward/{reward_id}/fulfilled_and_sent
Mark custom reward fulfilled and sent
POST
/v2/rewards/custom-reward/{reward_id}/redeemed
Mark custom reward redeemed
POST
/v2/rewards/custom-reward/{reward_id}/sent
Mark custom reward sent
GET
/v2/reward-suppliers/manual-coupons/{reward_supplier_id}/coupons
Download manual coupons
POST
/v2/reward-suppliers/manual-coupons/{reward_supplier_id}/coupons
Upload manual coupons file
DELETE
/v2/reward-suppliers/manual-coupons/{reward_supplier_id}/coupons
Delete manual coupons
GET
/v2/reward-suppliers/manual-coupons/{reward_supplier_id}/coupons{extension}
Download manual coupons file
GET
/v2/reward-suppliers/manual-coupons/{reward_supplier_id}/operations
Get manual coupon operations
GET
/v2/reward-suppliers/manual-coupons/{reward_supplier_id}/stats
Get manual coupon stats
GET
/v2/reward-suppliers/salesforce-coupons/list-available-coupon-pools
List Salesforce coupon pools
GET
/v2/reward-suppliers/salesforce-coupons/{reward_supplier_id}/operations
Get Salesforce coupon operations
GET
/v2/reward-suppliers/salesforce-coupons/{reward_supplier_id}/stats
Get Salesforce coupon stats
GET
/v2/reward-suppliers/tango/catalog
Get Tango catalog
GET
/v6/reward-suppliers
List reward suppliers
POST
/v6/reward-suppliers
Create a reward supplier
GET
/v6/reward-suppliers/built
List built reward suppliers
GET
/v6/reward-suppliers/display-types
Get reward supplier display types
GET
/v6/reward-suppliers/{reward_supplier_id}
Get a reward supplier
PUT
/v6/reward-suppliers/{reward_supplier_id}
Update a reward supplier
DELETE
/v6/reward-suppliers/{reward_supplier_id}
Archive a reward supplier
GET
/v6/reward-suppliers/{reward_supplier_id}/built
Get a built reward supplier
POST
/v2/reward-suppliers/salesforce-coupons/{reward_supplier_id}/coupons
Refill Salesforce coupons
DELETE
/v2/reward-suppliers/salesforce-coupons/{reward_supplier_id}/coupons
Delete Salesforce coupons
POST
/v6/reward-suppliers/{reward_supplier_id}/unarchive
Unarchive a reward supplier
DELETE
/v6/reward-suppliers/{reward_supplier_id}/delete
Delete a reward supplier
Schemas 144
The contract defines 144 schemas that model the data the API accepts and returns. The most detailed are BuiltRewardSupplierResponseBase (24 properties), RewardSupplierResponseBase (23 properties), RewardResponse (22 properties), RewardSupplierCreateRequestBase (20 properties). Each schema is shown below with its type and property counts.
TangoRewardSupplierCreateRequest
object
4 required
FaceValueInRewardSupplierUpdateRequestBase
Choose between static or dynamic face value
LimitPerHourInTangoRewardSupplierUpdateRequest
Choose between static or dynamic limit per hour
EnabledInRewardSupplierUpdateRequestBase
Choose between static or dynamic enabled
LimitPerHourInManualCouponRewardSupplierCreateRequest
Choose between static or dynamic limit per hour
LimitPerHourInPayPalPayoutsRewardSupplierCreateRequest
Choose between static or dynamic limit per hour
RewardExpiresAtInPayPalPayoutsRewardSupplierUpdateRequest
Choose between static or dynamic reward expires at
LimitPerHourInSalesforceCouponRewardSupplierUpdateRequest
Choose between static or dynamic limit per hour
BuiltTangoRewardSupplierResponse
object
tango reward supplier after buildtime evaluation. Fields displaytype, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cashbackmax, limitper…
31 required
RewardExpiresAtInRewardSupplierResponseBase
The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically.
FormDataContentDisposition
object
8 properties
DescriptionInRewardSupplierUpdateRequestBase
Choose between static or dynamic description
LimitPerDayInTangoRewardSupplierUpdateRequest
Choose between static or dynamic limit per day
PayPalPayoutsRewardSupplierUpdateRequest
object
1 required
FaceValueAlgorithmTypeInRewardSupplierCreateRequestBase
Choose between static or dynamic face value algorithm type
SalesforceCouponRewardSupplierUpdateRequest
object
1 required
TangoRewardSupplierResponse
object
Stored tango reward supplier definition. Fields displaytype, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cashbackmax, limitperday, limi…
31 required
DisplayNameInCustomRewardSupplierCreateRequest
Choose between static or dynamic display name
SalesforceCouponRewardSupplierCreateRequest
object
2 required
CashBackPercentageInRewardSupplierResponseBase
The cash back percentage as configured: a literal value, or an expression (type:string) when defined dynamically.
LimitPerHourInTangoRewardSupplierCreateRequest
Choose between static or dynamic limit per hour
FailedRewardRequest
object
1 property
1 required
CashBackPercentageInRewardSupplierCreateRequestBase
Choose between static or dynamic cash back percentage
CashBackMaxInRewardSupplierUpdateRequestBase
Choose between static or dynamic cash back max
RewardSupplierResponse
24 required
RewardExpiresAtInManualCouponRewardSupplierCreateRequest
Choose between static or dynamic reward expires at
LimitPerDayInCustomRewardSupplierUpdateRequest
Choose between static or dynamic limit per day
DisplayNameInPayPalPayoutsRewardSupplierCreateRequest
Choose between static or dynamic display name
SalesforceCouponRewardSupplierResponse
object
Stored salesforce coupon reward supplier definition. Fields displaytype, facevaluetype, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cas…
28 required
LimitPerHourInManualCouponRewardSupplierUpdateRequest
Choose between static or dynamic limit per hour
DisplayNameInManualCouponRewardSupplierUpdateRequest
Choose between static or dynamic display name
ManualCouponRewardSupplierResponse
object
Stored manual coupon reward supplier definition. Fields displaytype, facevaluetype, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cashbac…
27 required
RewardSupplierCreateRequest
Body of a POST /v6/reward-suppliers request.
2 required
NameInRewardSupplierUpdateRequestBase
Choose between static or dynamic name
RewardExpiresAtInManualCouponRewardSupplierUpdateRequest
Choose between static or dynamic reward expires at
DescriptionInTangoRewardSupplierResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInSalesforceCouponRewardSupplierCreateRequest
Choose between static or dynamic description
FaceValueAlgorithmTypeInRewardSupplierUpdateRequestBase
Choose between static or dynamic face value algorithm type
LimitPerHourInRewardSupplierCreateRequestBase
Choose between static or dynamic limit per hour
CustomRewardSupplierResponse
object
Stored custom reward supplier definition. Fields name, displayname, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cashbackmax, limitperda…
31 required
CashBackMaxInRewardSupplierResponseBase
The cash back max as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltRewardSupplierResponse
reward supplier after buildtime evaluation. Fields displaytype, name, displayname, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cashback…
24 required
RewardExpiresAtInCustomRewardSupplierUpdateRequest
Choose between static or dynamic reward expires at
BuiltPayPalPayoutsRewardSupplierResponse
object
pay pal payouts reward supplier after buildtime evaluation. Fields displaytype, name, displayname, facevaluealgorithmtype, facevalue, cashbackpercentage, cashb…
26 required
DescriptionInSalesforceCouponRewardSupplierUpdateRequest
Choose between static or dynamic description
DisplayNameInRewardSupplierResponseBase
The display name as configured: a literal value, or an expression (type:string) when defined dynamically.
CashBackMinInRewardSupplierCreateRequestBase
Choose between static or dynamic cash back min
LimitPerHourInSalesforceCouponRewardSupplierCreateRequest
Choose between static or dynamic limit per hour
FaceValueTypeInRewardSupplierCreateRequestBase
Choose between static or dynamic face value type
DisplayTypeInRewardSupplierResponseBase
The display type as configured: a literal value, or an expression (type:string) when defined dynamically.
FulfilledRewardRequest
object
6 properties
6 required
FulfilledAndSentRewardRequest
object
7 properties
7 required
RewardExpiresAtInBuiltRewardSupplierResponseBase
The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically.
CashBackMinInRewardSupplierUpdateRequestBase
Choose between static or dynamic cash back min
LimitPerDayInSalesforceCouponRewardSupplierUpdateRequest
Choose between static or dynamic limit per day
DisplayNameInPayPalPayoutsRewardSupplierUpdateRequest
Choose between static or dynamic display name
BuiltManualCouponRewardSupplierResponse
object
manual coupon reward supplier after buildtime evaluation. Fields displaytype, facevaluetype, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin…
27 required
LimitPerDayInManualCouponRewardSupplierCreateRequest
Choose between static or dynamic limit per day
RewardSupplierResponseBase
object
23 properties
CashBackMinInRewardSupplierResponseBase
The cash back min as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInPayPalPayoutsRewardSupplierResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInRewardSupplierResponseBase
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
RewardSupplierUpdateRequest
Body of a PUT /v6/reward-suppliers/{rewardsupplierid} request.
1 required
SentRewardRequest
object
3 properties
3 required
DescriptionInRewardSupplierCreateRequestBase
Choose between static or dynamic description
DescriptionInCustomRewardSupplierUpdateRequest
Choose between static or dynamic description
LimitPerDayInRewardSupplierResponseBase
The limit per day as configured: a literal value, or an expression (type:string) when defined dynamically.
RewardSupplierUpdateRequestBase
object
20 properties
NameInRewardSupplierCreateRequestBase
Choose between static or dynamic name
DescriptionInTangoRewardSupplierCreateRequest
Choose between static or dynamic description
CustomRewardSupplierCreateRequest
object
3 required
LimitPerHourInRewardSupplierResponseBase
The limit per hour as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInManualCouponRewardSupplierUpdateRequest
Choose between static or dynamic description
DescriptionInCustomRewardSupplierCreateRequest
Choose between static or dynamic description
DescriptionInPayPalPayoutsRewardSupplierCreateRequest
Choose between static or dynamic description
TangoBrandItemResponse
object
8 properties
PayPalPayoutsRewardSupplierResponse
object
Stored pay pal payouts reward supplier definition. Fields displaytype, name, displayname, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, c…
26 required
JourneyKey
object
2 properties
DisplayNameInTangoRewardSupplierCreateRequest
Choose between static or dynamic display name
RewardResponse
object
22 properties
22 required
LimitPerDayInCustomRewardSupplierCreateRequest
Choose between static or dynamic limit per day
RewardExpiresAtInRewardSupplierUpdateRequestBase
Choose between static or dynamic reward expires at
NameInRewardSupplierResponseBase
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
SalesforceCouponPoolResponse
object
6 properties
6 required
RewardExpiresAtInPayPalPayoutsRewardSupplierCreateRequest
Choose between static or dynamic reward expires at
DisplayNameInTangoRewardSupplierUpdateRequest
Choose between static or dynamic display name
LimitPerDayInRewardSupplierCreateRequestBase
Choose between static or dynamic limit per day
FaceValueAlgorithmTypeInRewardSupplierResponseBase
The face value algorithm type as configured: a literal value, or an expression (type:string) when defined dynamically.
CouponPoolIdInSalesforceCouponRewardSupplierCreateRequest
Choose between static or dynamic coupon pool id
DescriptionInManualCouponRewardSupplierCreateRequest
Choose between static or dynamic description
RewardSupplierCreateRequestBase
object
20 properties
DisplayNameInSalesforceCouponRewardSupplierUpdateRequest
Choose between static or dynamic display name
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…
CashBackPercentageInRewardSupplierUpdateRequestBase
Choose between static or dynamic cash back percentage
RestExceptionResponse
object
Represents the API error response
5 properties
5 required
DisplayNameInSalesforceCouponRewardSupplierCreateRequest
Choose between static or dynamic display name
RedeemedRewardRequest
object
2 properties
2 required
TangoBrandResponse
object
5 properties
5 required
ComponentReferenceResponse
object
2 properties
LimitPerHourInCustomRewardSupplierCreateRequest
Choose between static or dynamic limit per hour
DisplayTypeInRewardSupplierCreateRequestBase
Choose between static or dynamic display type
ManualCouponRewardSupplierDownloadCouponsResponse
object
2 properties
2 required
LimitPerDayInPayPalPayoutsRewardSupplierUpdateRequest
Choose between static or dynamic limit per day
CashBackMaxInRewardSupplierCreateRequestBase
Choose between static or dynamic cash back max
DisplayNameInRewardSupplierCreateRequestBase
Choose between static or dynamic display name
DisplayNameInManualCouponRewardSupplierCreateRequest
Choose between static or dynamic display name
BuiltRewardSupplierResponseBase
object
24 properties
BuiltCustomRewardSupplierResponse
object
custom reward supplier after buildtime evaluation. Fields name, displayname, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cashbackmax, l…
31 required
ComponentReferenceRequest
object
2 properties
FaceValueTypeInRewardSupplierUpdateRequestBase
Choose between static or dynamic face value type
FaceValueInRewardSupplierCreateRequestBase
Choose between static or dynamic face value
LimitPerDayInPayPalPayoutsRewardSupplierCreateRequest
Choose between static or dynamic limit per day
RewardExpiresAtInSalesforceCouponRewardSupplierUpdateRequest
Choose between static or dynamic reward expires at
RewardExpiresAtInTangoRewardSupplierCreateRequest
Choose between static or dynamic reward expires at
RewardExpiresAtInCustomRewardSupplierCreateRequest
Choose between static or dynamic reward expires at
CouponPoolIdInSalesforceCouponRewardSupplierResponse
The coupon pool id as configured: a literal value, or an expression (type:string) when defined dynamically.
DisplayNameInRewardSupplierUpdateRequestBase
Choose between static or dynamic display name
PayPalPayoutsRewardSupplierCreateRequest
object
3 required
FaceValueTypeInRewardSupplierResponseBase
The face value type as configured: a literal value, or an expression (type:string) when defined dynamically.
LimitPerDayInSalesforceCouponRewardSupplierCreateRequest
Choose between static or dynamic limit per day
LimitPerDayInManualCouponRewardSupplierUpdateRequest
Choose between static or dynamic limit per day
BuiltSalesforceCouponRewardSupplierResponse
object
salesforce coupon reward supplier after buildtime evaluation. Fields displaytype, facevaluetype, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbac…
28 required
RewardExpiresAtInSalesforceCouponRewardSupplierCreateRequest
Choose between static or dynamic reward expires at
DescriptionInTangoRewardSupplierUpdateRequest
Choose between static or dynamic description
LimitPerHourInPayPalPayoutsRewardSupplierUpdateRequest
Choose between static or dynamic limit per hour
ManualCouponRewardSupplierUpdateRequest
object
1 required
DisplayTypeInRewardSupplierUpdateRequestBase
Choose between static or dynamic display type
ManualCouponRewardSupplierCreateRequest
object
3 required
EnabledInRewardSupplierCreateRequestBase
Choose between static or dynamic enabled
ManualCouponUploadResponse
object
2 properties
ManualCouponRewardSupplierOperationResponse
object
11 properties
11 required
LimitPerHourInRewardSupplierUpdateRequestBase
Choose between static or dynamic limit per hour
RewardExpiresAtInTangoRewardSupplierUpdateRequest
Choose between static or dynamic reward expires at
SalesforceCouponRewardSupplierOperationResponse
object
10 properties
10 required
TangoRewardSupplierUpdateRequest
object
1 required
FaceValueInRewardSupplierResponseBase
The face value as configured: a literal value, or an expression (type:string) when defined dynamically.
CouponStatsResponse
object
2 properties
2 required
LimitPerDayInRewardSupplierUpdateRequestBase
Choose between static or dynamic limit per day
RewardExpiresAtInRewardSupplierCreateRequestBase
Choose between static or dynamic reward expires at
LimitPerDayInTangoRewardSupplierCreateRequest
Choose between static or dynamic limit per day
CustomRewardSupplierUpdateRequest
object
1 required
LimitPerHourInCustomRewardSupplierUpdateRequest
Choose between static or dynamic limit per hour
DisplayNameInCustomRewardSupplierUpdateRequest
Choose between static or dynamic display name
DescriptionInPayPalPayoutsRewardSupplierUpdateRequest
Choose between static or dynamic description
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Extole 12
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
#Reward Suppliers