---
title: "Rename a scan"
method: PATCH
path: "/api/v1/scans/{scan_id}"
tags: ["scans"]
---

# Rename a scan

`PATCH /api/v1/scans/{scan_id}`

## Request

- Base URL: `https://api.sytecheck.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.sytecheck.app/api/v1/scans/{scan_id}`
- Auth: HTTP bearer

Update a scan's label. Send `{"label": null}` to clear it. Omitted fields are
left unchanged.

## Path parameters

- `scan_id` integer, required

## Request body

- ScanUpdate: Body for PATCH /api/v1/scans/:id — currently only the label is editable.
  - `label` string, nullable

## Response `200`

Successful Response

- ScanResponse: Scan summary — returned by POST and in the scan history list.
  - `id` integer, required
  - `url` string, required
  - `label` string, nullable, required
  - `status` 'queued' | 'scanning' | 'summarizing' | 'complete' | 'failed', required
  - `categories_requested` string[], required
  - `overall_score` number, nullable, required
  - `error_message` string, nullable
  - `webhook_url` string, nullable
  - `quota_refunded_at` string, date-time, nullable
  - `used_scan_credit` boolean
  - `created_at` string, date-time, required
  - `completed_at` string, date-time, nullable, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/sytecheck/apis/sytecheck-api.md) · [All operations](https://skmtc.dev/sytecheck/apis/sytecheck-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sytecheck/apis/sytecheck-api/revisions/797cf6b3e867?raw)