Referral Marketing Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Redeem Voucher
Redeem a voucher for an advocate or their referred friend.
- Resource
-
/vouchers/${voucherCode}/redemption - Resource example
-
https://yourInstance.salesforce.com/services/data/v64.0/vouchers/VC001/redemption - Available version
- 59.0
- Requires Chatter
- No
- HTTP methods
- POST
- Request body for POST
-
- JSON examples
- JSON request to redeem a voucher for an advocate
-
{ "currencyIsoCode": "Yen", "programName": "ReferAFriend", "redemptionAmount": "12", "memberId": "0lMxx00000001grEAA" } - JSON request to redeem a voucher for a referred friend
-
{ "currencyIsoCode": "Yen", "programName": "ReferAFriend", "redemptionAmount": "10", "contactId": "003xx000004WkhEAAS" } - Properties
-
Name Type Description Required or Optional Available Version contactId String Contact ID of the referred friend for whom the voucher is redeemed. Required only for a referral. 59.0 currencyIsoCode String Three-letter ISO 4217 currency code of the monetary currency in which the voucher must be redeemed. Optional This field is required if your Salesforce org supports multiple currencies.
59.0 memberId String Loyalty Program Member ID of the advocate for whom the voucher is redeemed. Required only for an advocate. This field is optional if you provide the membership number of the advocate.
59.0 membershipNumber String Unique number of the advocate for whom the voucher is redeemed. Required only for an advocate. This field is optional if you provide the member ID of the advocate.
59.0 programName String Name of the referral program to which the voucher belongs. Optional This field is required when you provide the membership number of the advocate.
59.0 redemptionAmount Double Amount to be redeemed. A value isn't required when you want to redeem the complete value of the voucher in a single transaction.
Optional 59.0
- Response body for POST
- Industries Redeem Voucher Output