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

# Update Fax

`PATCH /v1/fax/{faxId}`

## Request

- Base URL: `https://api.bluehive.com`
- URL: `https://api.bluehive.com/v1/fax/{faxId}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bluehive-health/apis/bluehive-api/docs/v1/fax/:faxId/patch.ts> (a function with typed inputs; its response is checked against the schema)

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

## Changes

- **2026-02-05** `63bca4bb1614`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bluehive-health/apis/bluehive-api/changes/v1/fax/:faxId/patch.md)

---

[API](https://skmtc.dev/bluehive-health/apis/bluehive-api.md) - [All operations](https://skmtc.dev/bluehive-health/apis/bluehive-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluehive-health/apis/bluehive-api/revisions/a8bcbdf02e33?raw)