faxes

Send a fax (debits prepaid credits)

post/api/v1/faxes

Request

  • Base URL: https://singlefax.com
  • URL: https://singlefax.com/api/v1/faxes
  • 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)

Headers

Idempotency-Keystring required

Request body

uploadTokenstring
base64string

Document bytes as base64 (PDF, Word, Excel, PowerPoint, RTF, text, or image)

contentTypestring

Optional MIME when sniffing is needed. 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

coverboolean

Response

Queued fax order

idstring required
idsstring[]

All order ids when sending to multiple destinations

recipientCountinteger
fulfillmentStatusstring required
paymentStatusstring required
subtotalCentsinteger
taxCentsinteger
totalCentsinteger
currencystring
billablePagesinteger
destinationCountrystring
destinationFaxNumberstring nullable
createdAtstring date-time
paymentChannelstring

Changes

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