FAfax
Faxes

Modify fax record

Changed on

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

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
    • 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
    • or HTTP bearer

Path parameters

user_idstring required

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

fax_idstring required

Request body

commentstring
is_readboolean
shared_commentstring

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

Fax updated successfully

Changes

  • 95a35a892239Revision changes
    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      added the non-success response with the status