git.pulls.mark-file-viewed

Mark one file viewed, or clear the mark, for yourself

PUT /git/api/repositories/{repoId}/pulls/{prNumber}/viewedIAM git:MarkFilesViewedChanges state

Request syntax

PUT /git/api/repositories/{repoId}/pulls/{prNumber}/viewed
{
  "path": "string",
  "viewed": "boolean"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

  • prNumberRequired

    number

    Constraints: integer, min 1

Request body

  • pathRequired

    string

    A changed file's path at the head

    Constraints: 1-1000 chars

  • viewedRequired

    boolean

    true marks it viewed, false clears the mark

Response

200 with the `path` and its `viewed` state now.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • pathAlways

    string

    The file
  • viewedAlways

    boolean

    Whether it is marked viewed now

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow git:MarkFilesViewed on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud git pulls mark-file-viewed repoId prNumber --path example --viewed

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_pulls_mark-file-viewed.