> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.fax.plus/llms.txt
> Use this file to discover all available pages before exploring further.
# Bulk update fax records
> Bulk update multiple fax records (mark as read/unread and/or update comment). Maximum 100 fax IDs per request. Duplicate IDs are automatically ignored. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)
```js NodeJS SDK theme={null}
const axios = require('axios');
const FaxesApiFp = require('@alohi/faxplus-api').FaxesApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;
const config = new Configuration({
accessToken: accessToken,
basePath: 'https://restapi.fax.plus/v3',
// Header required only when using the OAuth2 token scheme
baseOptions: {
headers: {
"x-fax-clientid": clientId,
}
}
});
async function bulkUpdateFaxes() {
const reqParams = {
"userId": "self",
"bulkFaxUpdateRequest": {
"ids": [
"a1b2c3d4e5f6789012345678901234ab",
"b2c3d4e5f6789012345678901234abc"
],
"is_read": true,
"comment": "updated via bulk"
}
};
const req = await FaxesApiFp(config).bulkUpdateFaxes(reqParams);
const resp = await req(axios);
}
bulkUpdateFaxes();
```
```python Python SDK theme={null}
from faxplus import ApiClient, FaxesApi, BulkFaxUpdateRequest
from faxplus.configuration import Configuration
conf = Configuration()
conf.access_token = access_token
# header_name and header_value required only when using the OAuth2 token scheme
api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
api = FaxesApi(api_client)
payload = BulkFaxUpdateRequest(
ids=[
"a1b2c3d4e5f6789012345678901234ab",
"b2c3d4e5f6789012345678901234abc",
],
is_read=True,
comment="updated via bulk",
)
resp = api.bulk_update_faxes(user_id="self", body=payload)
```
```bash cURL theme={null}
# You can also use wget
curl -X PUT "https://restapi.fax.plus/v3/accounts/self/faxes" \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
# The x-fax-clientid header is required only when using the OAuth2 token scheme
-H 'x-fax-clientid: YOUR_CLIENT_ID' \
-d '{
"ids": [
"a1b2c3d4e5f6789012345678901234ab",
"b2c3d4e5f6789012345678901234abc"
],
"is_read": true,
"comment": "updated via bulk"
}'
```
## OpenAPI
````yaml put /accounts/{user_id}/faxes
openapi: 3.0.1
info:
title: Fax.Plus REST API
description: >-
This is the Fax.Plus API v3 developed for third party developers and
organizations. In order to have a better coding experience with this API,
let's quickly go through some points:
- This API assumes
**/accounts** as an entry point with the base url of
**https://restapi.fax.plus/v3**.
- This API treats all date and
times sent to it in requests as **UTC**. Also, all dates and times returned
in responses are in **UTC**
- Once you have an access_token, you
can easily send a request to the resource server with the base url of
**https://restapi.fax.plus/v3** to access your permitted resources. As an
example to get the user's profile info you would send a request to
**https://restapi.fax.plus/v3/accounts/self** when **Authorization** header
is set to **Bearer YOUR_ACCESS_TOKEN** and custom header of
**x-fax-clientid** is set to YOUR_CLIENT_ID
version: 3.4.0
contact:
name: Fax.Plus
email: info@fax.plus
url: https://github.com/alohi
servers:
- url: https://restapi.fax.plus/v3
- url: /v3
security: []
paths:
/accounts/{user_id}/faxes:
put:
tags:
- Faxes
summary: Bulk update fax records
description: >-
Bulk update multiple fax records (mark as read/unread and/or update
comment). Maximum 100 fax IDs per request. Duplicate IDs are
automatically ignored. (Permitted scopes: **fax:all:edit**,
**fax:fax:edit**)
operationId: bulkUpdateFaxes
parameters:
- name: user_id
in: path
required: true
schema:
type: string
default: self
description: >-
User ID. Use 'self' for your own account, or provide a specific user
ID for corporate member accounts.
example: self
requestBody:
$ref: '#/components/requestBodies/BulkFaxUpdateRequest'
responses:
'200':
$ref: '#/components/responses/BulkOperationResultFax'
'400':
$ref: '#/components/responses/Error'
'401':
$ref: '#/components/responses/UnauthorizedError'
'500':
$ref: '#/components/responses/ServerError'
security:
- oauth2:
- all
- personal_access_token:
- fax:all:edit
- fax:fax:edit
components:
requestBodies:
BulkFaxUpdateRequest:
description: Request to bulk update multiple fax records
content:
application/json:
schema:
$ref: '#/components/schemas/BulkFaxUpdateRequest'
responses:
BulkOperationResultFax:
description: Response containing bulk operation results for faxes
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResultFax'
Error:
description: Error object in case there's a problem with given data
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: invalid_user_id
description: Invalid user id given
UnauthorizedError:
description: Error object in case there's a problem with the authorization
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: unauthorized
description: >-
The access token provided is expired, revoked, malformed, or
invalid for other reasons.
ServerError:
description: Error object in case there's a server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: internal_server_error
description: An unexpected error happened, please contact support
schemas:
BulkFaxUpdateRequest:
type: object
description: Request to bulk update multiple fax records
properties:
ids:
type: array
items:
type: string
minItems: 1
maxItems: 100
description: >-
List of fax IDs to update (1-100 unique IDs, each ID is max 32
characters). Duplicates are automatically ignored.
is_read:
type: boolean
description: >-
Mark faxes as read (true) or unread (false). Optional, but at least
one of is_read or comment must be provided.
comment:
type: string
maxLength: 100
description: >-
Comment text to set for all faxes. Send empty string to remove
comment. Optional, but at least one of is_read or comment must be
provided.
required:
- ids
additionalProperties: false
BulkOperationResultFax:
type: object
description: Bulk operation result for faxes
properties:
results:
type: array
items:
$ref: '#/components/schemas/BulkOperationResultItemFax'
description: Per-item results for each fax ID
required:
- results
additionalProperties: false
Error:
properties:
description:
type: string
error:
type: string
additionalProperties: false
BulkOperationResultItemFax:
type: object
description: Result for a single fax operation in bulk request
properties:
id:
description: Fax ID
type: string
code:
type: integer
description: >-
HTTP-like status code for this item: 204 (success), 404 (not found),
403 (forbidden), 409 (conflict/invalid state), 500 (server error)
enum:
- 204
- 403
- 404
- 409
- 500
required:
- id
- code
additionalProperties: false
securitySchemes:
oauth2:
type: oauth2
description: OAuth2 Authorization Grant
flows:
authorizationCode:
authorizationUrl: >-
https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
tokenUrl: https://accounts.fax.plus/token
refreshUrl: >-
https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=YOUR_REFRESH_TOKEN
scopes:
all: >-
for now when a user grants permission, all grants will be
permitted
personal_access_token:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Personal Access Token (PAT) is a Bearer token used for secure API calls.
For direct API calls, the PAT is used in the Authorization header as
'Bearer {PAT}'. For MCP usage, configure your PAT in your MCP client
settings (e.g., in your IDE's MCP server configuration) - authentication
will be handled automatically.
````