Update report visibility

Change a report's visibility

PATCH / v1 / reports / {id}

Change a report's visibility. Owner only — a non-owner (or unauthenticated request) gets 404, never revealing the report's existence. **Flipping a non-public report to `public` is credit-gated** (`report_publish`, 2 credits) when the request resolves to an organization, so unlisted/private can't be published public for free; it reuses the same idempotency key as publish-time, so a report originally published `public` (or already charged) flips for free. Insufficient credits block the transition with `402`.

Path parameters

id string required

Report id.

Request body required

visibility"public" | "unlisted" | "private"required

Available options: public, unlisted, private

Responses

Updated visibility.

id string required

visibility "public" | "unlisted" | "private" required

Available options: public, unlisted, private

url string (uri) required

curl --request PATCH \
  --url "https://api.squirrelscan.com/v1/reports/ID"

const res = await fetch("https://api.squirrelscan.com/v1/reports/ID", {
  method: "PATCH",
});
const data = await res.json();

import requests


r = requests.patch("https://api.squirrelscan.com/v1/reports/ID")
r.raise_for_status()
data = r.json()

{
  "id": "<string>",
  "visibility": "public",
  "url": "<url>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

Edit this page