HomeGuidesAPI ReferenceAPI Changelog
Log In
API Reference

Create a single reward

post
https://app.referralsaasquatch.com/api/v1//rewards/account//user/

Used to create a reward for a specified user. Note that the reward will only be redeemed automatically if the default program supports automatic redemption for the provided reward type (refer to the Advocate developer guides for more on automatic redemption).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the user that will be given the reward.

string
required

The ID of the account that will be given the reward.

string
required

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

Body Params

Details of the reward to create.

Details of a new reward to create.

string
enum

The type of reward.

Allowed:
integer

Timestamp of when this reward is set to expire.

integer

Timestamp of when the reward is sheduled to become available.

boolean

If a reward is cancellable then it may be revoked. If it has been cancelled then dateCancelled will be non-null.

string

An identifier for the unit of the reward. E.g. 'credit-in-cents', 'freemb', 'giftcard20', 'tshirt', 'freemonth' or '%'. Works with: CREDIT

integer

The percent discount. E.g. 10 means 10% Works with: PCT_DISCOUNT

integer

The earned quantity of the reward. Works with: CREDIT

string

For programs that require a currency. Works with: CREDIT

string
enum

The type of reward associated with this fueltank code. Works with: FUELTANK

Allowed:
string

The fueltank code associated with this reward. Works with: FUELTANK.

integer

The earned quantity of the reward. Works with: FUELTANK

Responses

Updated 7 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Did this page help you?