Send Fax

Sends a fax using the fax channel that matches the from phone number.

Provide body (plain text, converted to a PDF at send time), attachments (HTTPS URLs to
PDF/TIFF or similar documents), or both. One of body or attachments is required. When both are
present, the body PDF is sent first, then each attachment in order.

Each attachments URL must use HTTPS. Whippy downloads your files, stores copies in your
organization storage, and sends the fax from those Whippy-hosted URLs (same model as SMS/MMS
attachments). Scheduled sends re-host attachments when the request is accepted; body-only faxes
are composed when the scheduled job runs.

If there is no contact for to, a new contact is created along with a fax conversation on the from channel.

Optional schedule_at queues the fax for a future time (ISO 8601). Optional conversation_status
can set the conversation to automated, open, or closed when sending.

Reading inbound and outbound fax: Use the same Conversation APIs as for SMS—list or show a conversation
and its messages to view fax history; there is no separate fax-only read API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Send fax params

Request schema for sending a fax.

One of body or attachments is required.

The from number must belong to an enabled fax channel in your organization.

attachments
array of strings

HTTPS URLs of documents to send (up to 10). Whippy downloads each file, stores a copy in your
organization storage, and sends the fax using those Whippy-hosted URLs (same model as SMS/MMS
attachments). URLs must use HTTPS with a non-empty host.

attachments
string

Plain-text fax body. Whippy converts this to a PDF at send time (first page/leg).

string
enum

Status to set for the conversation. If omitted, the conversation status is unchanged.

Allowed:
string
required

Phone number of an existing fax channel belonging to your organization

date-time

Optional scheduling time. Requires ISO 8601 format.

string
required

Destination fax or phone number

Responses

Callback
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json