---
title: "Modify fax record"
method: PUT
path: "/accounts/{user_id}/faxes/{fax_id}"
tags: ["Faxes"]
---

# Modify fax record

`PUT /accounts/{user_id}/faxes/{fax_id}`

## Request

- Base URL: `https://restapi.fax.plus/v3`
- URL: `https://restapi.fax.plus/v3/accounts/{user_id}/faxes/{fax_id}`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all`
    - Token URL: `https://accounts.fax.plus/token` scopes: `all`
  - HTTP bearer

You can modify a fax record's comment, its shared comment, or mark it as read. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)

## Path parameters

- `user_id` string, required
- `fax_id` string, required

## Request body

- PayloadFaxModification
  - `comment` string
  - `is_read` boolean
  - `shared_comment` string: Shared note visible to all members of the corporate account. Requires a Business or Enterprise plan. Empty string clears the note. Returns HTTP 403 with error code `plan_not_eligible` when the account plan does not include shared notes

## Response `204`

Fax updated successfully

## Other responses

- `400`: Error object in case there's a problem with given data
- `403`: Error object in case there's a problem with given data
- `500`: Error object in case there's a server error

## Changes

- **2026-11-03** `95a35a892239`: 4 info
  - added the new optional request property `shared_comment`
  - the request property `comment` became optional
  - the request property `is_read` became optional
  - added the non-success response with the status `403`

[Operation history](https://skmtc.dev/fax/apis/fax-plus-rest-api/changes/accounts/:user_id/faxes/:fax_id/put.md)

---

[API](https://skmtc.dev/fax/apis/fax-plus-rest-api.md) - [All operations](https://skmtc.dev/fax/apis/fax-plus-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fax/apis/fax-plus-rest-api/revisions/95a35a892239?raw)