Update a fax log

Archives or restores a fax, or changes the subject and names shown for it.

Who may call it: an API key with All permissions, for every fax server of your account.

Use it: send any of fax_archived, fax_subject, fax_from_name and fax_to_name. Fields you omit keep their values; other keys are ignored.

Response: 200 { "success": true }.

Notes:

  • Only a sent fax's subject can be changed. A received fax's subject is written from its document and is cleared with it.
  • fax_from_name and fax_to_name are stored as sent.
  • A value of the wrong type ("fax_archived": "yes") is refused with 502 Unable to update fax log.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The fax's fax_log_uuid.

Body Params

Send any of the four fields; other keys are ignored. Fields you omit keep their values.

boolean

true archives the fax, false brings it back.

string | null

A sent fax's subject. Control characters are removed, spaces trimmed, and anything past 255 characters cut; an empty subject or null clears it. A received fax's subject can't be changed.

string

The sender's name shown for this fax.

string

The recipient's name shown for this fax.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json