---
title: "Redact"
method: POST
path: "/rest/api/3/redact"
tags: ["Issue redaction"]
---

# Redact

`POST /rest/api/3/redact`

Submit a job to redact issue field data. This will trigger the redaction of the data in the specified fields asynchronously.

The redaction status can be polled using the job id.

## Request body

- BulkRedactionRequest
  - `redactions` SingleRedactionRequest[]
    - `contentItem` ContentItem, required — Represents the content to redact
      - `entityId` string, required — The ID of the content entity. * For redacting an issue field, this will be the field ID (e.g., summary, customfield\_10000). * For redacting a comment, this will be the comment ID. * For redacting a worklog, this will be the worklog ID.
      - `entityType` 'issuefieldvalue' | 'issue-comment' | 'issue-worklog', required — The type of the entity to redact; It will be one of the following: * **issuefieldvalue** \- To redact in issue fields * **issue-comment** \- To redact in issue comments. * **issue-worklog** \- To redact in issue worklogs
      - `id` string, required — This would be the issue ID
    - `externalId` string, uuid, required — Unique id for the redaction request; ID format should be of UUID
    - `reason` string, required — The reason why the content is being redacted
    - `redactionPosition` RedactionPosition, required — Represents the position of the redaction
      - `adfPointer` string — The ADF pointer indicating the position of the text to be redacted. This is only required when redacting from rich text(ADF) fields. For plain text fields, this field can be omitted.
      - `expectedText` string, required — The text which will be redacted, encoded using SHA256 hash and Base64 digest
      - `from` integer, required — The start index(inclusive) for the redaction in specified content
      - `to` integer, required — The ending index(exclusive) for the redaction in specified content

## Response `202`

Returned if the job submission is successful. The response contains the job id.

- string, uuid

## Other responses

- `400` — Returned if the redaction request is invalid.
- `401` — Returned if the user / app is not authorised to redact data
- `403` — Returned if the AGP subscription is not present.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api-2/versions/5a51740d7ab3/schema)