Skip to main content
POST
Send a fax
Send a fax to a destination number. Authenticate with a Bearer access token obtained from Generate an access token.

Attach documents

Send the request as application/json. The fax_data property is an array of document objects. For each document, provide file_name and one of:
  • file_url: A publicly accessible URL for the PDF file.
  • file_data: The complete PDF file encoded as a Base64 string.
Do not include both file_url and file_data for the same document.

Fax templates

Use template_id to apply a Fax Default as the cover-page template. Customers can find the ID beneath the Fax Default name under Settings → iFax Settings → Fax Defaults. Use smart_document_id to apply a Smart Template. Customers can find the ID beneath the Smart Template name under Settings → iFax Settings → Smart Templates. template_id and smart_document_id cannot be used together. The fax_data array is always required with either option.

Phone number format

Supply fax_number and caller_id in E.164 format. Begin the number with +, followed by the country code and subscriber number, with no spaces, parentheses, or hyphens.

Fax quality

Set fax_quality to one of the following values: If omitted, fax quality comes from the selected Fax Default. When template_id is omitted, the account’s default Fax Default is used.

Fax priority

Set fax_priority to high or regular. The default is regular.

Caller ID

Supply caller_id to select the sending number explicitly. If omitted, caller ID comes from the selected Fax Default. When template_id is omitted, the fax_as value from the account’s default Fax Default is used.

Scheduling

Use scheduled_date to schedule transmission. Supply timestamps in ISO 8601 format, such as 2026-05-06T09:42:00Z.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
fax_number
string
required

Destination fax number in E.164 format.

Pattern: ^\+[1-9][0-9]{1,14}$
Example:

"+12509997881"

fax_data
object[]
required

Documents to include in the fax.

Minimum array length: 1
caller_id
string

Caller ID or sending fax number in E.164 format. When omitted, the value comes from the selected Fax Default or the account's default Fax Default.

Pattern: ^\+[1-9][0-9]{1,14}$
Example:

"+12513120176"

template_id
string

ID of a Fax Default used as the cover-page template. Find it under Settings > iFax Settings > Fax Defaults. Cannot be combined with smart_document_id.

Example:

"1055"

is_required_approval
boolean

Whether the fax requires approval before it is sent.

Example:

false

fax_priority
enum<string>
default:regular

Fax priority.

Available options:
high,
regular
Example:

"high"

smart_document_id
string

ID of a Smart Template. Find it under Settings > iFax Settings > Smart Templates. Cannot be combined with template_id.

Example:

"10210"

subject
string

Fax subject.

Example:

"Test Subject"

from_name
string

Sender name.

Example:

"Sender Name"

to_name
string

Recipient name.

Example:

"Recipient Name"

message
string

Message associated with the fax.

Example:

"Fax sent through the Amplify API"

scheduled_date
string<date-time>

Scheduled transmission date and time in ISO 8601 format.

Example:

"2026-05-06T09:42:00Z"

fax_quality
enum<string>

Requested fax quality. When omitted, the value comes from the selected Fax Default or the account's default Fax Default.

Available options:
low,
standard,
hd
Example:

"hd"

Response

Fax processed for sending.

status
integer
required
message
string
required
Allowed value: "Fax processed for sending"
data
object
required