v1

latestOpenAPI 3.0.12026-07-266184114.0 KB
Files

Upload a file

Before sending a fax you need to upload your files using this API. In order to upload your fax file, you have to send a multipart/form-data request with your file. Set the name to fax_file, filename to your file's name with extension, and the Content-Type to the file's MIME type. In most cases, the filename directive will be automatically added by your library of choice. If the upload was successful you would receive a file_path which you can use to send your fax. (Permitted scopes: fax:all:edit, fax:file:edit)

post/accounts/{user_id}/files

Path parameters

user_idstring required

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

Query parameters

format'tiff' | 'pdf'

File type

Can be 'pdf' or 'tiff'

Response

Simple object containing path of created file

pathstring required

Path of newly uploaded file

Example response

{
  "path": "/storage/2937237320213-213-21323"
}