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)
Request
- Base URLhttps://restapi.fax.plus/v3
- URLhttps://restapi.fax.plus/v3/accounts/{user_id}/files
- Auth
- OAuth 2Authorization code: https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=allToken URL: https://accounts.fax.plus/token scopes: all
- or HTTP bearer
Path parameters
User ID. Use 'self' for your own account, or provide a specific user ID for corporate member accounts.
Query parameters
File type
Can be 'pdf' or 'tiff'
Request body multipart/form-data
Example request
{
"fax_file": "fax.pdf"
}Response
Simple object containing path of created file
Example response
{
"path": "/storage/2937237320213-213-21323"
}Changes
No recorded changes to this operation across all 2 revisions of this API.