---
title: "Update Fax"
method: PATCH
path: "/v1/fax/{faxId}"
tags: ["Fax Management"]
---

# Update Fax

`PATCH /v1/fax/{faxId}`

Update fax metadata such as brandId, pageData, or splits.

## Path parameters

- `faxId` string, required

## Request body

- object
  - `brandId` string, nullable
  - `pageData` object[]
    - `pageNum` integer, required
    - `orderItemId` string, nullable
    - `formId` string, nullable
  - `splits` object[]
    - `formId` string, nullable
    - `orderItemId` string, nullable

## Response `200`

Default Response

- object
  - `success` boolean, required
  - `message` string, required
  - `fax` object
    - `_id` string
    - `faxId` string
    - `storagePath` string
    - `receivedAt` string, date-time
    - `status` 'received' | 'queued' | 'processing' | 'completed' | 'error'
    - `attempts` integer
    - `lastError` string
    - `startedAt` string, date-time
    - `finishedAt` string, date-time
    - `scannedAt` string, date-time
    - `brandId` string, nullable
    - `pageData` object[]
      - `pageNum` integer
      - `codes` object[]
        - `raw` string — Original scanned QR code value
        - `data` object — Extracted data from parsing the raw QR string (orderCode, orderNumber, formId, url, etc.)
        - `derived` object — Derived/resolved data from DB lookups (orderItemId, etc.)
      - `formId` string, nullable
      - `orderItemId` string, nullable
    - `splits` object[]
      - `formId` string, nullable
      - `orderItemId` string, nullable
      - `storagePath` string
      - `pageNums` integer[]
      - `createdAt` string, date-time
      - `meta` object
        - `pageCount` integer
        - `fileSize` integer
    - `meta` object
      - `pageCount` integer
      - `fileSize` integer

## Other responses

- `400` — Default Response
- `401` — Default Response
- `404` — Default Response
- `500` — Default Response

---

[API](https://skmtc.net/bluehive-health/apis/bluehive-api.md) · [All operations](https://skmtc.net/bluehive-health/apis/bluehive-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bluehive-health/bluehive-api/revisions/e6e553c2594a/schema)