Redeem Voucher (POST)

Redeem a voucher for an advocate or their referred friend.

Resource 

1/vouchers/$VOUCHER_CODE/redemption

Resource Example:

1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/vouchers/VC001/redemption

Available Version 

59.0

Requires Chatter 

No

HTTP Methods 

POST

Request Body for POST 

JSON Request to Redeem a Voucher for an Advocate 

1{
2  "currencyIsoCode": "Yen",
3  "programName": "ReferAFriend",
4  "redemptionAmount": "12",
5  "memberId": "0lMxx00000001grEAA"
6}

JSON Request to Redeem a Voucher for a Referred Friend 

1{
2  "currencyIsoCode": "Yen",
3  "programName": "ReferAFriend",
4  "redemptionAmount": "10",
5  "contactId": "003xx000004WkhEAAS"
6}

Request Body Properties 

contactId 

Contact ID of the referred friend for whom the voucher is redeemed.

Type: String. Required only for a referral. Available in version 59.0.

currencyIsoCode 

Three-letter ISO 4217 currency code of the monetary currency in which the voucher must be redeemed.

Type: String. Optional. This field is required if your Salesforce org supports multiple currencies. Available in version 59.0.

memberId 

Loyalty Program Member ID of the advocate for whom the voucher is redeemed.

Type: String. Required only for an advocate. This field is optional if you provide the membership number of the advocate. Available in version 59.0.

membershipNumber 

Unique number of the advocate for whom the voucher is redeemed.

Type: String. Required only for an advocate. This field is optional if you provide the member ID of the advocate. Available in version 59.0.

programName 

Name of the referral program to which the voucher belongs.

Type: String. Optional. This field is required when you provide the membership number of the advocate. Available in version 59.0.

redemptionAmount 

Amount to be redeemed.

A value isn’t required when you want to redeem the complete value of the voucher in a single transaction.

Type: Double. Optional. Available in version 59.0.

Response Body for POST 

Industries Redeem Voucher