Endpoint: https://rest.virtualincentives.com/{version}/{format}/recipients/{id}/cancel

Method: PUT

Definitions

Field	Type	Description
note	optional string(500)	Optional note to be stored with the requested action.
events	response only object	A list of all the events related to this action. For definitions, see Get Recipient Events.

Examples

Request XML (Optional)

<recipient>
    <note>Test</note>
</recipient>

Request JSON (Optional)

{
    "recipient": {
        "note":"Test"
    }
}

Response XML

<recipient>
  <id>263849</id>
  <events>
    <event>
      <id>566802</id>
      <date>03/30/2021 10:09</date>
      <name>Reward Canceled</name>
    </event>
    <event>
      <id>566803</id>
      <date>03/30/2021 10:09</date>
      <name>Credit Applied</name>
      <note>$100.00</note>
    </event>
    <event>
      <id>566804</id>
      <date>03/30/2021 10:09</date>
      <name>Cancel Fee</name>
      <note>($5.95)</note>
    </event>
  </events>
</recipient>

Response JSON

{
  "recipient": {
    "id": "263857",
    "events": [
      {
        "id": "566847",
        "date": "03/31/2021 13:56",
        "name": "Reward Canceled"
      },
      {
        "id": "566848",
        "date": "03/31/2021 13:56",
        "name": "Credit Applied",
        "note": "$100.00"
      },
      {
        "id": "566849",
        "date": "03/31/2021 13:56",
        "name": "Cancel Fee",
        "note": "($3.95)"
      }
    ]
  }
}