---
title: "redact_issue_text"
description: "Generated reference for the management action redact_issue_text: its description, access metadata, payload contract, and registration status."
slug: /reference/actions/redact-issue-text
order: 87
visibility: public
redirects_from: []
---

# redact\_issue\_text

Generated automatically from the [published contract sources](/cloud/reference/about/#contract-sources).

A script calls this action over HTTPS at `POST https://tztrack.turnzero.ai/v1/redact_issue_text`, with a bearer credential and the action's payload as the JSON body. An MCP connection lists this action as the tool `tztrack_redact_issue_text`.

OAuth access tokens and minted tokens, including the turnzero command's computer token, are bearer credentials. The action determines which kinds, scopes and grants it accepts ([Sign-in, sessions, and tokens](/cloud/concepts/sign-in-sessions-and-tokens/)).

**Build metadata:** Registered in this build. Registration describes the default dispatcher in this build. It does not guarantee that a caller has the required credential or grant, that a tool is listed for that connection, or that the required service is configured.

## Contract description

Ask to redact text spans or remove an image on an issue you reach at the owner level\. Nothing changes until a person approves the pending action in the browser\. Give them the approval link\. Read the outcome with `read_approval_status`\. The act has no undo\. Earlier history values remain, and restoring an earlier daily copy can bring text back\.

## More about this action

`space` is the space's lower\-case UUID, and `issue` is its identifier `#n`\. `target` selects one comment by number, a linked report's text by number, an issue member, or an image by id\. The issue members are `summary`, `workaround`, `resolution` and `note_to_reporters`\.

For text, `ranges` holds 1 to 100 pairs of `start` and `end` character offsets in the current text\. Each end follows its start, no ranges overlap, and none passes the text's end\. For an image, `ranges` is absent\. Approval replaces each span with `[redacted]` or removes the image's bytes whole\.

The pending description gives the space, issue, target and span count or image, without the text\. A changed target declines the pending action as `description_changed`\. A new request provides a new approval link\. The outcome gives `redacted`, the span count or 1 for an image, and the changed `issue` identifier or `report` number, without text\.

Earlier values in history remain\. One `redacted` history entry records the act and the acting account without the value, qualified by an issues token's label where one asked\. There is no undo action\. Restoring a daily copy taken before the redaction can bring text back\.

Admitted credentials are a signed\-in session, the AI tool's own tzTrack sign\-in or device sign\-in, or an issues token at `owner` for that space with the destructive class\. A credential without that class is refused `destructive_class_required`\. A tzTrack token minted by `mint_token` is refused `tztrack_bounded`\.

The space's owner and a member at `owner` can request it\. The platform's own space is reached by its owning account and its owner\-level members\. Every other caller is refused `space_not_owned`, without revealing whether the space or issue exists\.

An invalid target or ranges is refused `invalid_request` before a pending action is created\. At owner level, an issue outside the space is refused `issue_refused` with `issue_not_found`; an absent target is refused `invalid_request`\. An unreadable service or vault is refused `issue_service_unreachable`\.

With `request_id`, a repeat is safe\. While the earlier pending action is requested, approved or executing, the same account's same `request_id` returns it and creates no second one\. After it completes, fails, is declined or expires, that identity starts a new pending action\.

## Access and action metadata

```json
{
  "name": "redact_issue_text",
  "resource": "account",
  "tier": "destructive",
  "surface": "tztrack",
  "addresses": [
    "tztools"
  ],
  "admits": [
    "tztrack",
    "device_sign_in",
    "issues"
  ],
  "summary": "Redact text spans or remove an image on one issue through a pending action approved in the browser. The request changes nothing. `space`, `issue`, `target` and `ranges` name the current content; ranges are required for text and absent for an image. Approval returns a span count or 1 for an image and the changed issue or report, without text. History retains prior values. The act has no undo; restoring a daily copy taken before it can bring text back. A space's owner and owner-level members can request it. An issues token needs owner level for that space and the destructive class. The AI tool's own tzTrack sign-in and device sign-in are admitted. Other callers are refused `space_not_owned` without revealing whether the space or issue exists. A credential without the destructive class is refused `destructive_class_required`, and a tzTrack token minted by `mint_token` is refused `tztrack_bounded`. Invalid targets or ranges are refused `invalid_request` before any pending action. An unreadable service or vault is refused `issue_service_unreachable`. Registered while the issue service's origin is configured.",
  "annotations": {
    "readOnlyHint": false,
    "destructiveHint": true,
    "openWorldHint": false
  }
}
```

## MCP catalog entry

```json
{
  "name": "redact_issue_text",
  "title": "Redact issue content",
  "tier": "destructive",
  "scenario": "API-L0-20",
  "summary": "Ask to redact text spans or remove an image on an issue you reach at the owner level. Nothing changes until a person approves the pending action in the browser. Give them the approval link. Read the outcome with `read_approval_status`. The act has no undo. Earlier history values remain, and restoring an earlier daily copy can bring text back.",
  "owners": [
    "ITS-L0-05",
    "API-L0-06",
    "API-L0-07",
    "MAPI-05",
    "MAPI-12",
    "MAPI-16"
  ]
}
```

## request

| JSON pointer | Description and constraints |
|---|---|
| "" \(root\) | Type: object<br>Required fields: \["space","issue","target"\]<br>Additional properties: false |
| /<wbr>properties/<wbr>space | The space you reach at the owner level, as a lower\-case UUID\.<br><br>Type: string<br>Pattern: ^\[0\-9a\-f\]\{8\}\-\[0\-9a\-f\]\{4\}\-\[0\-9a\-f\]\{4\}\-\[0\-9a\-f\]\{4\}\-\[0\-9a\-f\]\{12\}$ |
| /<wbr>properties/<wbr>issue | The issue's identifier, `#n`, within that space\.<br><br>Type: string<br>Pattern: ^\#\[1\-9\]\[0\-9\]\{0,15\}$ |
| /<wbr>properties/<wbr>target | Exactly one: `comment`, its number on the issue; `report`, a linked report's number for its text; `member`, one of `summary`, `workaround`, `resolution`, `note_to_reporters`; or `attachment`, an image's id on the issue's reports or comments\.<br><br>Type: object<br>minProperties: 1<br>maxProperties: 1<br>Additional properties: false |
| /<wbr>properties/<wbr>target/<wbr>properties/<wbr>comment | Type: integer<br>Minimum: 1 |
| /<wbr>properties/<wbr>target/<wbr>properties/<wbr>report | Type: integer<br>Minimum: 1 |
| /<wbr>properties/<wbr>target/<wbr>properties/<wbr>member | Type: string<br>Allowed values: \["summary","workaround","resolution","note\_to\_reporters"\] |
| /<wbr>properties/<wbr>target/<wbr>properties/<wbr>attachment | Type: string<br>Pattern: ^\[0\-9a\-f\]\{8\}\-\[0\-9a\-f\]\{4\}\-\[0\-9a\-f\]\{4\}\-\[0\-9a\-f\]\{4\}\-\[0\-9a\-f\]\{12\}$ |
| /<wbr>properties/<wbr>ranges | Required for text and absent for an image: 1 to 100 `{ start, end }` offsets in the current text\. Each end follows its start, no ranges overlap, and none passes the text's end\.<br><br>Type: array<br>Minimum items: 1<br>Maximum items: 100 |
| /<wbr>properties/<wbr>ranges/<wbr>items | Type: object<br>Required fields: \["start","end"\]<br>Additional properties: false |
| /<wbr>properties/<wbr>ranges/<wbr>items/<wbr>properties/<wbr>start | Type: integer<br>Minimum: 0 |
| /<wbr>properties/<wbr>ranges/<wbr>items/<wbr>properties/<wbr>end | Type: integer<br>Minimum: 1 |
| /<wbr>properties/<wbr>request\_id | Any string you choose\. A repeat from the same account while that pending action is live returns it again, creating no second one\. Omitted, every call creates a new one\.<br><br>Type: string |

## response

| JSON pointer | Description and constraints |
|---|---|
| "" \(root\) | The 202 envelope holds the pending action and its approval link\. Approval replaces text spans with \[redacted\] or removes the image's bytes\. Read the outcome through read\_approval\_status: redacted is the span count or 1 for an image, beside the changed issue identifier or report number\. No text is returned\.<br><br>Type: object<br>Required fields: \["contract\_version","pending\_action","approval\_url"\] |
| /<wbr>properties/<wbr>contract\_version | Required value: 1 |
| /<wbr>properties/<wbr>reference | The short reference the platform recorded your call under: ten lowercase hexadecimal characters, the value in the call's record row\. Quote it when you report the call\.<br><br>Type: string<br>Pattern: ^\[0\-9a\-f\]\{10\}$ |
| /<wbr>properties/<wbr>pending\_action | $ref: \#/shapes/pending\_action |
| /<wbr>properties/<wbr>approval\_url | Type: string |
| /<wbr>properties/<wbr>detail | Type: string |

## Complete payload contract

```json
{
  "request": {
    "type": "object",
    "required": [
      "space",
      "issue",
      "target"
    ],
    "properties": {
      "space": {
        "type": "string",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
        "description": "The space you reach at the owner level, as a lower-case UUID."
      },
      "issue": {
        "type": "string",
        "pattern": "^#[1-9][0-9]{0,15}$",
        "description": "The issue's identifier, `#n`, within that space."
      },
      "target": {
        "type": "object",
        "description": "Exactly one: `comment`, its number on the issue; `report`, a linked report's number for its text; `member`, one of `summary`, `workaround`, `resolution`, `note_to_reporters`; or `attachment`, an image's id on the issue's reports or comments.",
        "properties": {
          "comment": {
            "type": "integer",
            "minimum": 1
          },
          "report": {
            "type": "integer",
            "minimum": 1
          },
          "member": {
            "type": "string",
            "enum": [
              "summary",
              "workaround",
              "resolution",
              "note_to_reporters"
            ]
          },
          "attachment": {
            "type": "string",
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
          }
        },
        "minProperties": 1,
        "maxProperties": 1,
        "additionalProperties": false
      },
      "ranges": {
        "type": "array",
        "minItems": 1,
        "maxItems": 100,
        "description": "Required for text and absent for an image: 1 to 100 `{ start, end }` offsets in the current text. Each end follows its start, no ranges overlap, and none passes the text's end.",
        "items": {
          "type": "object",
          "required": [
            "start",
            "end"
          ],
          "properties": {
            "start": {
              "type": "integer",
              "minimum": 0
            },
            "end": {
              "type": "integer",
              "minimum": 1
            }
          },
          "additionalProperties": false
        }
      },
      "request_id": {
        "type": "string",
        "description": "Any string you choose. A repeat from the same account while that pending action is live returns it again, creating no second one. Omitted, every call creates a new one."
      }
    },
    "additionalProperties": false
  },
  "response": {
    "type": "object",
    "description": "The 202 envelope holds the pending action and its approval link. Approval replaces text spans with [redacted] or removes the image's bytes. Read the outcome through read_approval_status: redacted is the span count or 1 for an image, beside the changed issue identifier or report number. No text is returned.",
    "required": [
      "contract_version",
      "pending_action",
      "approval_url"
    ],
    "properties": {
      "contract_version": {
        "const": 1
      },
      "reference": {
        "type": "string",
        "pattern": "^[0-9a-f]{10}$",
        "description": "The short reference the platform recorded your call under: ten lowercase hexadecimal characters, the value in the call's record row. Quote it when you report the call."
      },
      "pending_action": {
        "$ref": "#/shapes/pending_action"
      },
      "approval_url": {
        "type": "string"
      },
      "detail": {
        "type": "string"
      }
    }
  }
}
```

## Shared contracts

- [Refusals](/cloud/reference/refusals/): every refusal, by surface, with its cause and its remedy
- [schemas/wire\_error\.schema\.json](/cloud/reference/sources/schemas/wire-error-schema/)
- [schemas/wire\_errors\.json](/cloud/reference/sources/schemas/wire-errors/)
- [schemas/action\_payloads\.json](/cloud/reference/sources/schemas/action-payloads/) (includes shared shapes)
- [management\_api\_contract\.md](/cloud/reference/sources/management-api-contract/)
