Redact Recipient Data
Endpoint: https://rest.virtualincentives.com/{version}/{format}/recipients/{id}/redact
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>123456</id>
<events>
<event>
<id>345678</id>
<date>01/30/2020 12:00</date>
<name>Data Redacted</name>
</event>
</events>
</recipient>
Response JSON
{"recipient":{
"id":"123456","events":[
{"id":"345678",
"date":"01/20/2020 12:00",
"name":"Data Redacted"}]}}
Updated over 3 years ago