How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Extole

Extole Reward Suppliers API

The Reward Suppliers API from Extole — 21 operation(s) for reward suppliers.

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.0, 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.

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

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
failCustomReward 1 param body → 200400401402403415429
POST
/v2/rewards/custom-reward/{reward_id}/fulfilled
Mark custom reward fulfilled
fulfillCustomReward 1 param body → 200400401402403415429
POST
/v2/rewards/custom-reward/{reward_id}/fulfilled_and_sent
Mark custom reward fulfilled and sent
fulfillAndSendCustomReward 1 param body → 200400401402403415429
POST
/v2/rewards/custom-reward/{reward_id}/redeemed
Mark custom reward redeemed
redeemCustomReward 1 param body → 200400401402403415429
POST
/v2/rewards/custom-reward/{reward_id}/sent
Mark custom reward sent
sendCustomReward 1 param body → 200400401402403415429
GET
/v2/reward-suppliers/manual-coupons/{reward_supplier_id}/coupons
Download manual coupons
downloadManualCoupons 6 params → 200400401402403415429
POST
/v2/reward-suppliers/manual-coupons/{reward_supplier_id}/coupons
Upload manual coupons file
uploadManualCouponsFile 5 params body → 200400401402403415429
DELETE
/v2/reward-suppliers/manual-coupons/{reward_supplier_id}/coupons
Delete manual coupons
deleteManualCoupons 2 params → 200400401402403415429
GET
/v2/reward-suppliers/manual-coupons/{reward_supplier_id}/coupons{extension}
Download manual coupons file
downloadManualCouponsFile 7 params → 200400401402403415429
GET
/v2/reward-suppliers/manual-coupons/{reward_supplier_id}/operations
Get manual coupon operations
getManualCouponOperations 4 params → 200400401402403415429
GET
/v2/reward-suppliers/manual-coupons/{reward_supplier_id}/stats
Get manual coupon stats
getManualCouponStats 1 param → 200400401402403415429
GET
/v2/reward-suppliers/salesforce-coupons/list-available-coupon-pools
List Salesforce coupon pools
listSalesforceCouponPools → 200400401402403415429
GET
/v2/reward-suppliers/salesforce-coupons/{reward_supplier_id}/operations
Get Salesforce coupon operations
getSalesforceCouponOperations 3 params → 200400401402403415429
GET
/v2/reward-suppliers/salesforce-coupons/{reward_supplier_id}/stats
Get Salesforce coupon stats
getSalesforceCouponStats 1 param → 200400401402403415429
GET
/v2/reward-suppliers/tango/catalog
Get Tango catalog
getTangoCatalog → 200400401402403415429503
GET
/v6/reward-suppliers
List reward suppliers
listRewardSuppliers 2 params → 200400401402403415429
POST
/v6/reward-suppliers
Create a reward supplier
createRewardSupplier body → 200400401402403415429503
GET
/v6/reward-suppliers/built
List built reward suppliers
listBuiltRewardSuppliers 4 params → 200400401402403415429
GET
/v6/reward-suppliers/display-types
Get reward supplier display types
getRewardSupplierDisplayTypes → 200400401402403415429
GET
/v6/reward-suppliers/{reward_supplier_id}
Get a reward supplier
getRewardSupplier 1 param → 200400401402403415429
PUT
/v6/reward-suppliers/{reward_supplier_id}
Update a reward supplier
updateRewardSupplier 1 param body → 200400401402403415429503
DELETE
/v6/reward-suppliers/{reward_supplier_id}
Archive a reward supplier
archiveRewardSupplier 1 param → 200400401402403415429
GET
/v6/reward-suppliers/{reward_supplier_id}/built
Get a built reward supplier
getBuiltRewardSupplier 1 param → 200400401402403415429
POST
/v2/reward-suppliers/salesforce-coupons/{reward_supplier_id}/coupons
Refill Salesforce coupons
refillSalesforceCoupons 1 param → 200400401402403415429
DELETE
/v2/reward-suppliers/salesforce-coupons/{reward_supplier_id}/coupons
Delete Salesforce coupons
deleteSalesforceCoupons 2 params → 200400401402403415429
POST
/v6/reward-suppliers/{reward_supplier_id}/unarchive
Unarchive a reward supplier
unarchiveRewardSupplier 1 param → 200400401402403415429
DELETE
/v6/reward-suppliers/{reward_supplier_id}/delete
Delete a reward supplier
deleteRewardSupplier 1 param → 200400401402403415429

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.

DescriptionInPayPalPayoutsRewardSupplierUpdateRequest
Choose between static or dynamic description
LimitPerDayInRewardSupplierResponseBase
The limit per day as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInRewardSupplierUpdateRequestBase
Choose between static or dynamic description
ManualCouponRewardSupplierDownloadCouponsResponse
object
2 properties 2 required
PayPalPayoutsRewardSupplierUpdateRequest
object
1 required
JourneyKey
object
2 properties
DescriptionInCustomRewardSupplierCreateRequest
Choose between static or dynamic description
BuiltTangoRewardSupplierResponse
object
tango reward supplier after buildtime evaluation. Fields displaytype, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cashbackmax, limitper…
31 required
FaceValueAlgorithmTypeInRewardSupplierCreateRequestBase
Choose between static or dynamic face value algorithm type
RewardSupplierCreateRequestBase
object
20 properties
RewardSupplierCreateRequest
Body of a POST /v6/reward-suppliers request.
2 required
CouponPoolIdInSalesforceCouponRewardSupplierCreateRequest
Choose between static or dynamic coupon pool id
LimitPerDayInManualCouponRewardSupplierUpdateRequest
Choose between static or dynamic limit per day
ManualCouponRewardSupplierOperationResponse
object
11 properties 11 required
SalesforceCouponPoolResponse
object
6 properties 6 required
LimitPerDayInTangoRewardSupplierCreateRequest
Choose between static or dynamic limit per day
ManualCouponUploadResponse
object
2 properties
CouponStatsResponse
object
2 properties 2 required
RewardExpiresAtInRewardSupplierCreateRequestBase
Choose between static or dynamic reward expires at
FaceValueTypeInRewardSupplierCreateRequestBase
Choose between static or dynamic face value type
RewardExpiresAtInBuiltRewardSupplierResponseBase
The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically.
CouponPoolIdInSalesforceCouponRewardSupplierResponse
The coupon pool id as configured: a literal value, or an expression (type:string) when defined dynamically.
LimitPerDayInPayPalPayoutsRewardSupplierCreateRequest
Choose between static or dynamic limit per day
BuiltRewardSupplierResponse
reward supplier after buildtime evaluation. Fields displaytype, name, displayname, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cashback…
24 required
BuiltRewardSupplierResponseBase
object
24 properties
DisplayTypeInRewardSupplierCreateRequestBase
Choose between static or dynamic display type
FaceValueInRewardSupplierCreateRequestBase
Choose between static or dynamic face value
PayPalPayoutsRewardSupplierResponse
object
Stored pay pal payouts reward supplier definition. Fields displaytype, name, displayname, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, c…
26 required
RewardSupplierUpdateRequestBase
object
20 properties
SalesforceCouponRewardSupplierResponse
object
Stored salesforce coupon reward supplier definition. Fields displaytype, facevaluetype, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cas…
28 required
CashBackMaxInRewardSupplierResponseBase
The cash back max as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltSalesforceCouponRewardSupplierResponse
object
salesforce coupon reward supplier after buildtime evaluation. Fields displaytype, facevaluetype, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbac…
28 required
DisplayNameInManualCouponRewardSupplierCreateRequest
Choose between static or dynamic display name
DescriptionInPayPalPayoutsRewardSupplierCreateRequest
Choose between static or dynamic description
CashBackMaxInRewardSupplierUpdateRequestBase
Choose between static or dynamic cash back max
RewardExpiresAtInRewardSupplierUpdateRequestBase
Choose between static or dynamic reward expires at
DisplayNameInPayPalPayoutsRewardSupplierCreateRequest
Choose between static or dynamic display name
DisplayNameInManualCouponRewardSupplierUpdateRequest
Choose between static or dynamic display name
DisplayNameInSalesforceCouponRewardSupplierUpdateRequest
Choose between static or dynamic display name
CashBackPercentageInRewardSupplierUpdateRequestBase
Choose between static or dynamic cash back percentage
CustomRewardSupplierResponse
object
Stored custom reward supplier definition. Fields name, displayname, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cashbackmax, limitperda…
31 required
LimitPerDayInSalesforceCouponRewardSupplierUpdateRequest
Choose between static or dynamic limit per day
ComponentReferenceResponse
object
2 properties
SalesforceCouponRewardSupplierCreateRequest
object
2 required
CashBackPercentageInRewardSupplierCreateRequestBase
Choose between static or dynamic cash back percentage
TangoRewardSupplierResponse
object
Stored tango reward supplier definition. Fields displaytype, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cashbackmax, limitperday, limi…
31 required
DisplayNameInRewardSupplierUpdateRequestBase
Choose between static or dynamic display name
FormDataContentDisposition
object
8 properties
NameInRewardSupplierCreateRequestBase
Choose between static or dynamic name
RewardExpiresAtInRewardSupplierResponseBase
The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically.
LimitPerHourInCustomRewardSupplierUpdateRequest
Choose between static or dynamic limit per hour
CustomRewardSupplierUpdateRequest
object
1 required
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…
PayPalPayoutsRewardSupplierCreateRequest
object
3 required
DisplayNameInCustomRewardSupplierCreateRequest
Choose between static or dynamic display name
DisplayNameInSalesforceCouponRewardSupplierCreateRequest
Choose between static or dynamic display name
CashBackPercentageInRewardSupplierResponseBase
The cash back percentage as configured: a literal value, or an expression (type:string) when defined dynamically.
CashBackMaxInRewardSupplierCreateRequestBase
Choose between static or dynamic cash back max
ComponentReferenceRequest
object
2 properties
EnabledInRewardSupplierResponseBase
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInTangoRewardSupplierCreateRequest
Choose between static or dynamic description
DescriptionInCustomRewardSupplierUpdateRequest
Choose between static or dynamic description
FaceValueInRewardSupplierUpdateRequestBase
Choose between static or dynamic face value
FulfilledAndSentRewardRequest
object
7 properties 7 required
DisplayTypeInRewardSupplierUpdateRequestBase
Choose between static or dynamic display type
LimitPerHourInSalesforceCouponRewardSupplierUpdateRequest
Choose between static or dynamic limit per hour
FaceValueInRewardSupplierResponseBase
The face value as configured: a literal value, or an expression (type:string) when defined dynamically.
RewardExpiresAtInTangoRewardSupplierCreateRequest
Choose between static or dynamic reward expires at
RewardExpiresAtInCustomRewardSupplierUpdateRequest
Choose between static or dynamic reward expires at
TangoBrandItemResponse
object
8 properties
RewardExpiresAtInManualCouponRewardSupplierCreateRequest
Choose between static or dynamic reward expires at
DescriptionInSalesforceCouponRewardSupplierUpdateRequest
Choose between static or dynamic description
DisplayNameInPayPalPayoutsRewardSupplierUpdateRequest
Choose between static or dynamic display name
RewardExpiresAtInPayPalPayoutsRewardSupplierUpdateRequest
Choose between static or dynamic reward expires at
BuiltManualCouponRewardSupplierResponse
object
manual coupon reward supplier after buildtime evaluation. Fields displaytype, facevaluetype, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin…
27 required
CashBackMinInRewardSupplierCreateRequestBase
Choose between static or dynamic cash back min
FailedRewardRequest
object
1 property 1 required
DisplayNameInTangoRewardSupplierUpdateRequest
Choose between static or dynamic display name
RewardExpiresAtInCustomRewardSupplierCreateRequest
Choose between static or dynamic reward expires at
DescriptionInManualCouponRewardSupplierCreateRequest
Choose between static or dynamic description
RedeemedRewardRequest
object
2 properties 2 required
LimitPerDayInCustomRewardSupplierUpdateRequest
Choose between static or dynamic limit per day
RewardSupplierResponseBase
object
23 properties
ManualCouponRewardSupplierUpdateRequest
object
1 required
LimitPerHourInManualCouponRewardSupplierCreateRequest
Choose between static or dynamic limit per hour
RewardExpiresAtInTangoRewardSupplierUpdateRequest
Choose between static or dynamic reward expires at
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
DescriptionInSalesforceCouponRewardSupplierCreateRequest
Choose between static or dynamic description
LimitPerDayInRewardSupplierCreateRequestBase
Choose between static or dynamic limit per day
EnabledInRewardSupplierCreateRequestBase
Choose between static or dynamic enabled
RewardExpiresAtInSalesforceCouponRewardSupplierCreateRequest
Choose between static or dynamic reward expires at
LimitPerDayInCustomRewardSupplierCreateRequest
Choose between static or dynamic limit per day
LimitPerDayInPayPalPayoutsRewardSupplierUpdateRequest
Choose between static or dynamic limit per day
EnabledInRewardSupplierUpdateRequestBase
Choose between static or dynamic enabled
DescriptionInTangoRewardSupplierResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
SalesforceCouponRewardSupplierOperationResponse
object
10 properties 10 required
DisplayNameInCustomRewardSupplierUpdateRequest
Choose between static or dynamic display name
DescriptionInRewardSupplierCreateRequestBase
Choose between static or dynamic description
LimitPerDayInRewardSupplierUpdateRequestBase
Choose between static or dynamic limit per day
DisplayNameInTangoRewardSupplierCreateRequest
Choose between static or dynamic display name
SentRewardRequest
object
3 properties 3 required
CustomRewardSupplierCreateRequest
object
3 required
RewardExpiresAtInSalesforceCouponRewardSupplierUpdateRequest
Choose between static or dynamic reward expires at
DescriptionInManualCouponRewardSupplierUpdateRequest
Choose between static or dynamic description
LimitPerHourInTangoRewardSupplierCreateRequest
Choose between static or dynamic limit per hour
LimitPerHourInManualCouponRewardSupplierUpdateRequest
Choose between static or dynamic limit per hour
LimitPerHourInTangoRewardSupplierUpdateRequest
Choose between static or dynamic limit per hour
RewardSupplierUpdateRequest
Body of a PUT /v6/reward-suppliers/{rewardsupplierid} request.
1 required
LimitPerDayInTangoRewardSupplierUpdateRequest
Choose between static or dynamic limit per day
ManualCouponRewardSupplierCreateRequest
object
3 required
CashBackMinInRewardSupplierUpdateRequestBase
Choose between static or dynamic cash back min
RewardResponse
object
22 properties 22 required
LimitPerHourInSalesforceCouponRewardSupplierCreateRequest
Choose between static or dynamic limit per hour
RewardSupplierResponse
24 required
BuiltPayPalPayoutsRewardSupplierResponse
object
pay pal payouts reward supplier after buildtime evaluation. Fields displaytype, name, displayname, facevaluealgorithmtype, facevalue, cashbackpercentage, cashb…
26 required
DisplayNameInRewardSupplierCreateRequestBase
Choose between static or dynamic display name
FaceValueAlgorithmTypeInRewardSupplierUpdateRequestBase
Choose between static or dynamic face value algorithm type
LimitPerHourInRewardSupplierCreateRequestBase
Choose between static or dynamic limit per hour
LimitPerHourInPayPalPayoutsRewardSupplierCreateRequest
Choose between static or dynamic limit per hour
LimitPerDayInManualCouponRewardSupplierCreateRequest
Choose between static or dynamic limit per day
DisplayTypeInRewardSupplierResponseBase
The display type as configured: a literal value, or an expression (type:string) when defined dynamically.
CashBackMinInRewardSupplierResponseBase
The cash back min as configured: a literal value, or an expression (type:string) when defined dynamically.
LimitPerHourInRewardSupplierUpdateRequestBase
Choose between static or dynamic limit per hour
TangoRewardSupplierUpdateRequest
object
1 required
LimitPerHourInCustomRewardSupplierCreateRequest
Choose between static or dynamic limit per hour
LimitPerHourInPayPalPayoutsRewardSupplierUpdateRequest
Choose between static or dynamic limit per hour
FaceValueTypeInRewardSupplierResponseBase
The face value type 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.
BuiltCustomRewardSupplierResponse
object
custom reward supplier after buildtime evaluation. Fields name, displayname, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cashbackmax, l…
31 required
SalesforceCouponRewardSupplierUpdateRequest
object
1 required
NameInRewardSupplierUpdateRequestBase
Choose between static or dynamic name
TangoRewardSupplierCreateRequest
object
4 required
LimitPerDayInSalesforceCouponRewardSupplierCreateRequest
Choose between static or dynamic limit per day
LimitPerHourInRewardSupplierResponseBase
The limit per hour as configured: a literal value, or an expression (type:string) when defined dynamically.
FaceValueTypeInRewardSupplierUpdateRequestBase
Choose between static or dynamic face value type
ManualCouponRewardSupplierResponse
object
Stored manual coupon reward supplier definition. Fields displaytype, facevaluetype, facevaluealgorithmtype, facevalue, cashbackpercentage, cashbackmin, cashbac…
27 required
FulfilledRewardRequest
object
6 properties 6 required
DescriptionInTangoRewardSupplierUpdateRequest
Choose between static or dynamic description
FaceValueAlgorithmTypeInRewardSupplierResponseBase
The face value algorithm type as configured: a literal value, or an expression (type:string) when defined dynamically.
RewardExpiresAtInManualCouponRewardSupplierUpdateRequest
Choose between static or dynamic reward expires at
RewardExpiresAtInPayPalPayoutsRewardSupplierCreateRequest
Choose between static or dynamic reward expires at
TangoBrandResponse
object
5 properties 5 required
DisplayNameInRewardSupplierResponseBase
The display name as configured: a literal value, or an expression (type:string) when defined dynamically.
NameInRewardSupplierResponseBase
The name as configured: a literal value, or an expression (type:string) when defined dynamically.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-reward-suppliers-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
AE Profile APIs.io
Extole Authentication API
AE Profile APIs.io
Extole Batch Jobs API
AE Profile APIs.io
Extole Blocks API
AE Profile APIs.io
Extole Campaign Controllers Actions API
AE Profile APIs.io
Extole Campaign Controllers API
AE Profile APIs.io
Extole Campaign Controllers Triggers API
AE Profile APIs.io
Extole Campaign Flow Steps API
AE Profile APIs.io
Extole Campaigns API
AE Profile APIs.io
Extole Components API
AE Profile APIs.io
Extole Components Grants API
AE Profile APIs.io
Extole Components Settings API
AE Profile APIs.io
#Reward Suppliers
← Back to E APIs
API Details
ID
extole:extole-reward-suppliers-api
Base URL
https://api.extole.io
Docs
https://docs.extole.com/
Provider
Extole
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=extole-reward-suppliers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/extole-reward-suppliers-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Extole Reward Suppliers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.