Reward
Authorize your requests using a tenant's API Key. Use this method of security only in server-to-server interactions.
Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"
The ID of the account to look up
Filters rewards by user.id.
Filters rewards by type.
A list of rewards
A list of Reward objects.
The unique identifier for this reward
6a1702d0eb067e53ef6493bcA secondary unique identifier for this reward.
Unix timestamp (milliseconds) when the reward record was created.
1779892944095The ID of the program this reward belongs to. Null if not associated with a specific program.
The program-level key identifying the reward configuration.
The global key identifying the reward configuration.
The ID of the referral that triggered this reward. Null if the reward was created manually.
The type of reward.
Unix timestamp (milliseconds) when this reward was earned.
Unix timestamp (milliseconds) when this reward expires. Null if the reward does not expire.
Unix timestamp (milliseconds) when the reward was cancelled. Null if it has never been cancelled.
Unix timestamp (milliseconds) when the reward is scheduled to become available. Null if available immediately.
If a reward is cancellable then it may be revoked. If it has been cancelled then dateCancelled will be non-null.
The type of the source of the reward.
An identifier for the unit of the reward. E.g. 'credit-in-cents', 'freemb', 'giftcard20', 'tshirt', 'freemonth' or '%'
The percent discount. E.g. 10 means 10% Works with: PCT_DISCOUNT
The human-readable name of the reward.
The human-readable description of the reward. Works with: INTEGRATION
The earned quantity of the reward. Works with: CREDIT
The redeemed quantity of the reward. Works with: CREDIT
For programs that require a currency. Works with: CREDIT
The earned quantity of the reward. Works with: FUELTANK
The fueltank code associated with this reward. Works with: FUELTANK
The type of reward associated with this fueltank code. Works with: FUELTANK.
Unexpected Error
Authorize your requests using a tenant's API Key. Use this method of security only in server-to-server interactions.
Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"
The ID of the specific reward to lookup
Reward information
Rewards are used by impact.com to track the credits, discounts, gift cards and other prizes that a User earns.
The unique identifier for this reward
6a1702d0eb067e53ef6493bcA secondary unique identifier for this reward.
Unix timestamp (milliseconds) when the reward record was created.
1779892944095The ID of the program this reward belongs to. Null if not associated with a specific program.
The program-level key identifying the reward configuration.
The global key identifying the reward configuration.
The ID of the referral that triggered this reward. Null if the reward was created manually.
The type of reward.
Unix timestamp (milliseconds) when this reward was earned.
Unix timestamp (milliseconds) when this reward expires. Null if the reward does not expire.
Unix timestamp (milliseconds) when the reward was cancelled. Null if it has never been cancelled.
Unix timestamp (milliseconds) when the reward is scheduled to become available. Null if available immediately.
If a reward is cancellable then it may be revoked. If it has been cancelled then dateCancelled will be non-null.
The type of the source of the reward.
An identifier for the unit of the reward. E.g. 'credit-in-cents', 'freemb', 'giftcard20', 'tshirt', 'freemonth' or '%'
The percent discount. E.g. 10 means 10% Works with: PCT_DISCOUNT
The human-readable name of the reward.
The human-readable description of the reward. Works with: INTEGRATION
The earned quantity of the reward. Works with: CREDIT
The redeemed quantity of the reward. Works with: CREDIT
For programs that require a currency. Works with: CREDIT
The earned quantity of the reward. Works with: FUELTANK
The fueltank code associated with this reward. Works with: FUELTANK
The type of reward associated with this fueltank code. Works with: FUELTANK.
Reward not found
Unexpected Error
Authorize your requests using a tenant's API Key. Use this method of security only in server-to-server interactions.
Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"
The ID of the specific reward to be redeemed
A request to debit a single reward
The amount of credit to be debitted.
200The type of credit to be debitted. E.g. "free-months" or "cents"
centsReward debitted
Details about a successful Reward Balance Debit transaction.
The amount of credit that was just debitted.
200The remaining credit in this account of the same unit type.
1800The type of credit that was just debitted.
centsUnexpected Error
Authorize your requests using a tenant's API Key. Use this method of security only in server-to-server interactions.
Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"
The ID of the specific reward to be cancelled.
Reward cancelled
Rewards are used by impact.com to track the credits, discounts, gift cards and other prizes that a User earns.
The unique identifier for this reward
6a1702d0eb067e53ef6493bcA secondary unique identifier for this reward.
Unix timestamp (milliseconds) when the reward record was created.
1779892944095The ID of the program this reward belongs to. Null if not associated with a specific program.
The program-level key identifying the reward configuration.
The global key identifying the reward configuration.
The ID of the referral that triggered this reward. Null if the reward was created manually.
The type of reward.
Unix timestamp (milliseconds) when this reward was earned.
Unix timestamp (milliseconds) when this reward expires. Null if the reward does not expire.
Unix timestamp (milliseconds) when the reward was cancelled. Null if it has never been cancelled.
Unix timestamp (milliseconds) when the reward is scheduled to become available. Null if available immediately.
If a reward is cancellable then it may be revoked. If it has been cancelled then dateCancelled will be non-null.
The type of the source of the reward.
An identifier for the unit of the reward. E.g. 'credit-in-cents', 'freemb', 'giftcard20', 'tshirt', 'freemonth' or '%'
The percent discount. E.g. 10 means 10% Works with: PCT_DISCOUNT
The human-readable name of the reward.
The human-readable description of the reward. Works with: INTEGRATION
The earned quantity of the reward. Works with: CREDIT
The redeemed quantity of the reward. Works with: CREDIT
For programs that require a currency. Works with: CREDIT
The earned quantity of the reward. Works with: FUELTANK
The fueltank code associated with this reward. Works with: FUELTANK
The type of reward associated with this fueltank code. Works with: FUELTANK.
Reward is not cancellable
Reward does not exist
Unexpected Error
Authorize your requests using a tenant's API Key. Use this method of security only in server-to-server interactions.
Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"
The ID of the user that will be given the reward.
The ID of the account that will be given the reward.
Details of a new reward to create.
The type of reward.
PCT_DISCOUNTPossible values: Unix timestamp (milliseconds) when this reward is set to expire.
1471028988000Unix timestamp (milliseconds) when the reward is scheduled to become available.
If a reward is cancellable then it may be revoked. If it has been cancelled then dateCancelled will be non-null.
trueAn identifier for the unit of the reward. E.g. 'credit-in-cents', 'freemb', 'giftcard20', 'tshirt', 'freemonth' or '%'. Works with: CREDIT
The percent discount. E.g. 10 means 10% Works with: PCT_DISCOUNT
15The earned quantity of the reward. Works with: CREDIT
For programs that require a currency. Works with: CREDIT
The type of reward associated with this fueltank code. Works with: FUELTANK
The fueltank code associated with this reward. Works with: FUELTANK.
The earned quantity of the reward. Works with: FUELTANK
Reward created
Unexpected Error
Last updated