---
updatedAt: 2026-09-08T22:14:15.000Z
agentTools:
  projectIndex: https://developers.virtualincentives.com/llms.txt
---

# Redact Recipient Data

**Endpoint:** `https://rest.virtualincentives.com/{version}/{format}/recipients/{id}/redact`

**Method:** `PUT`

# Definitions

| Field  | Type                          | Description                                                                                                               |
| ------ | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| note   | **optional**<br />string(500) | Optional note to be stored with the requested action.                                                                     |
| events | **response only**<br />object | A list of all the events related to this action. For definitions, see [Get Recipient Events](https://developers.virtualincentives.com/docs/get-recipient-events-1). |

# Examples

## Request XML (Optional)

```text
<recipient>
    <note>Test</note>
</recipient>
```

## Request JSON (Optional)

```text
{
    "recipient": {
        "note":"Test"
    }
}
```

## Response XML

```text
<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

```text
{"recipient":{

"id":"123456","events":[

{"id":"345678",
"date":"01/20/2020 12:00",
"name":"Data Redacted"}]}}
```