---
title: "Redact Chat Comment"
method: PUT
path: "/api/v2/chat_redactions/{ticket_id}"
tags: ["Ticket Comments"]
---

# Redact Chat Comment

`PUT /api/v2/chat_redactions/{ticket_id}`

Permanently removes words or strings from a chat ticket's comment. 

Wrap `<redact>` tags around the content in the chat comment you want redacted. Example: 

```json
{
  "text": "My ID number is <redact>847564</redact>!"
}
```

The characters contained in the tag will be replaced by the ▇ symbol.

**Note**: This does not work on active chats. For chat tickets that predate March 2020, consider using [Redact Ticket Comment In Agent Workspace](#redact-ticket-comment-in-agent-workspace).

#### Allowed For

- Agents

[Agent Workspace](https://support.zendesk.com/hc/en-us/articles/360024218473) must enabled for the account. Deleting tickets must be enabled for agents.

#### Request Body Properties

| Name                     | Type    | Required | Description                                                                                                                                                                                                                                       |
| ------------------------ | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| chat_id                  | string  | true     | The `chat_id` in the `ChatStartedEvent` event in the ticket audit. See [Ticket Audits](/api-reference/ticketing/tickets/ticket_audits)                                                                                                            |
| chat_index               | integer | false    | The `chat_index` in the `ChatMessage` event in the ticket audit. See [Ticket Audits](/api-reference/ticketing/tickets/ticket_audits). Mandatory if `message_id` is not used                                                                       |
| message_id               | string  | false    | The `message_id` of the `ChatMessage` event in the ticket audit that is part of a `ChatStartedEvent` history. Used when redacting a ChatMessage that is part of a conversation history. Mandatory if `chat_index` is not used                     |
| text                     | string  | true     | The `message` in the `ChatMessage` event in the ticket audit. See [Ticket Audits](/api-reference/ticketing/tickets/ticket_audits).  Wrap `message` with `<redact>` tags                                                                           |

To get the required body properties, make a request to the [Ticket Audit](/api-reference/ticketing/tickets/ticket_audits) endpoint. Example response:

```http
Status 200 OK
{
  "audits": [
    "events": [
      {
        "id": 1932802680168,
        "type": "ChatStartedEvent",
        "value": {
          "visitor_id": "10502823-16EkM3T6VNq7KMd",
          "chat_id": "2109.10502823.Sjuj2YrBpXwei",
          "history": [
            {
              "chat_index": 0,
              "type": "ChatMessage",
              "message": "My ID number is 847564!"
            }
          ]
        }
      }
    ]
  ]
}
```

## Response `200`

Success response

- TicketChatCommentRedactionResponse
  - `chat_event` object — Chat event object
    - `id` integer — Id assigned to the chat event object
    - `type` string — Type of chat event
    - `value` object — The value of the chat event object
      - `chat_id` string — Id of the chat session
      - `history` object[] — Chat events within the chat session
      - `visitor_id` string — Id assigned to the visitor

---

[API](https://skmtc.dev/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.dev/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botbrains-io/support-api/revisions/d53eac07ba68/schema)