Skip to main content
POST

Authorizations

Authorization
string
header
required

OAuth2 Authorization Grant

FlowAuthorization Code
Authorization URL
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
Refresh URL
https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=YOUR_REFRESH_TOKEN
Scopes1
all
for now when a user grants permission, all grants will be permitted

Path Parameters

user_id
string
default:self
required

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

Query Parameters

format
enum<string>

Can be 'pdf' or 'tiff' File type

Available options:
tiff,
pdf

Body

multipart/form-data

A file to be uploaded. The file can be in PDF, TIFF, Word, Excel, RTF or image format.

File to be uploaded

fax_file
file
required

Path to file to upload

Response

Simple object containing path of created file

File path object

path
string
required

Path of newly uploaded file