API Reference
Start typing to search…

Send fax

post
https://api.whippy.co/v1/messaging/fax

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

The document must be reachable at attachment_url using HTTPS.

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.

Body Params

Send fax params

uri
required

HTTPS URL of the document to send (for example a PDF)

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

Updated about 5 hours ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 5 hours ago