Newer Version Available

This content describes an older version of this product. View Latest

Cancel a Voucher

Change the status of a voucher to canceled.

Example URL

1/connect/loyalty/programs/DemoProgram/program-processes/cancelVoucher

The request and response parameters vary depending on the input and output parameters configured for the CancelVoucher process in a Salesforce org.

Sample JSON Request

The value of a default request parameter can be an ID, a name, or a number, as shown in the following samples..

Sample1

1{
2   "processParameters":[
3      {
4         "MemberId":"0lMxx00000000BJEAY",
5         "VoucherId":"0kdxx000000000B245"
6      }
7   ]
8}

Sample2

1{
2   "processParameters":[
3      {
4         "MembershipNumber":"003",
5         "VoucherCode":"15OFF"
6      }
7   ]
8}

Sample JSON Response

1{
2   "message":null,
3   "outputParameters":{
4      "outputParameters":{
5         "results":[
6            {
7               "VoucherId":"0kDRM0000004Ct22AE"
8            }
9         ]
10      }
11   },
12   "simulationDetails":{
13      
14   },
15   "status":true
16}