Skip to main content
PUT
/
accounts
/
{user_id}
/
faxes
/
{fax_id}
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 updateFax() {
    const reqParams = {
        "userId": '13d8z73c',
        "faxId": '132esd4cs31',
        "payloadFaxModification": undefined
    }
    const req = await FaxesApiFp(config).updateFax(reqParams);
    const resp = await req(axios);
}

updateFax()

{
  "error": "invalid_user_id",
  "description": "Invalid user id given"
}

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.

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 updateFax() {
    const reqParams = {
        "userId": '13d8z73c',
        "faxId": '132esd4cs31',
        "payloadFaxModification": undefined
    }
    const req = await FaxesApiFp(config).updateFax(reqParams);
    const resp = await req(axios);
}

updateFax()

Authorizations

​
Authorization
string
header
required

OAuth2 Authorization Grant

Path Parameters

​
user_id
string
default:self
required

User ID. Use 'self' for your own account, or provide a specific user ID for corporate member accounts.

​
fax_id
string
required

Body

application/json

Request object for making changes in a fax object

​
comment
string
required
​
is_read
boolean
required

Response

Fax updated successfully