Delete a fax document

delete

https://api.emaktalk.com/api/v1/fax/logs/{logId}

Deletes a fax's document. The fax log stays, with no document left: is_deleted becomes true, and fax_file and s3_url are cleared.

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

Effect:

The document is removed from storage. This can't be undone.
A subject written from the document goes with it: always on a received fax, and on a sent fax when nobody typed it.

Response: 200 Fax file deleted successfully. When another fax log still uses the same document, it is kept for that one: the answer then carries storage kept.

Logged: the deletion is added to the fax's access history (access_type x), with the client's IP address and user agent.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The document was deleted, or the fax log let go of a document another fax log still uses.

400 Invalid Data Invalid Fax Log ID, Unable to Delete Fax File!: logId is not a UUID. Bad Request File has already been deleted!: the fax has no document left.

401No usable API key: none sent, a key that doesn't exist or was revoked (a revoked key stops working within a minute), or two kinds of credentials at once.

403Unauthorized Access No Fax Access!: the key is Scoped.

404Not Found Fax Log Not Found or Unauthorized!: no fax with this id is on your account.

503Your key could not be checked just now; the key may be fine. Wait Retry-After seconds and retry.