v1

latestOpenAPI 3.0.12026-07-266184114.0 KB

Outbox

Send a fax

Send a fax to one or more destinations. For corporate members without a fax number assigned set the 'from' parameter to 'no_number'. (Permitted scopes: fax:all:edit, fax:fax:edit). To randomly select one of the available numbers per recipient, use comma-separated string.

post/accounts/{user_id}/outbox

Path parameters

user_idstring required

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

Request body

fromstring required

Number to use for sending the fax. Use comma-separated string to randomly select one of the numbers per-recipient

tostring[] required

List of fax destination numbers

filesstring[]

List of file names to send. Files should be uploaded beforehand. Required unless from_fax is provided. Can be combined with from_fax to append additional files before the referenced fax file.

send_timestring

Date when to send the fax. Format: YYYY-MM-DD HH:mm:ss +HHMM

return_idsboolean

Return scheduled fax IDs to use for tracking and with webhooks

resolution'fine' | 'superfine'

Fax resolution. Valid values: fine, superfine

Example request

{
  "comment": {
    "tags": [
      "tag1",
      "tag2"
    ],
    "text": "text comment"
  },
  "files": [
    "filetosend.pdf"
  ],
  "from": "+12345667",
  "options": {
    "enhancement": true,
    "retry": {
      "count": 2,
      "delay": 15
    }
  },
  "send_time": "2000-01-01 01:02:03 +0000",
  "to": [
    "+12345688",
    "+12345699"
  ],
  "return_ids": true
}

Response

Outbox fax has been created successfully

idsobject

Destination-to-ID mapping

Example response

{
  "ids": {
    "+1234567890": "1a2b3c4d5e6f7890",
    "+1345678912": "78901a2b3c4d5e6f"
  }
}