uploads

Create a short-lived upload capability

Returns an uploadToken and a PUT URL. Requires fax:send (API key) or a dashboard session.

post/api/v1/uploads

Request

  • Base URL: https://singlefax.com
  • URL: https://singlefax.com/api/v1/uploads
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.singlefax.com/api/auth/oauth2/authorize, token URL https://api.singlefax.com/api/auth/oauth2/token, scopes: fax:send)

Request body

contentTypestring

MIME type. Allowed: application/pdf, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/rtf, text/rtf, text/plain, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation, image/png, image/jpeg, image/gif, image/webp, image/bmp, image/heic, image/heif, image/tiff

maxBytesinteger

Response

Upload token + PUT URL

uploadTokenstring required
uploadUrlstring uri required
method'PUT'
keystring
contentTypestring
maxBytesinteger
expiresAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.