Redact String in Comment

PUT {{baseUrl}}/api/v2/tickets/:ticket_id/comments/:ticket_comment_id/redact

Permanently removes words or strings from a ticket comment. Specify the string to redact in an object with a text property. Example: '{"text": "987-65-4320"}'. The characters of the word or string are replaced by the ▇ symbol.

If the comment was made by email, the endpoint also attempts to redact the string from the original email retained by Zendesk for audit purposes.

Note: If you use the rich text editor, support for redacting formatted text (bold, italics, hyperlinks) is limited.

Redaction is permanent. You can't undo the redaction or see what was removed. Once a ticket is closed, you can no longer redact strings from its comments.

To use this endpoint, the Agents can delete tickets option must be enabled in the Zendesk Support admin interface at Admin > Settings > Agents.

Allowed For

• Agents

HEADERS

RESPONSES

status: OK

{"comment":{"author_id":1,"id":35436,"plain_body":"My social security number is ▇▇▇▇!","type":"Comment"}}