BLbluehive-health
Fax Services

Send Fax

Changed on

Send a fax document to a specified number using the configured fax provider.

post/v1/fax/send

Request

Request body

tostring required

Recipient fax number (E.164 format preferred)

fromstring

Sender fax number (optional, uses default if not provided)

subjectstring

Subject line for the fax

providerstring

Optional provider override (uses default if not specified)

Response

Default Response

idstring required

Unique fax identifier

status'queued' | 'dialing' | 'sending' | 'delivered' | 'failed' | 'cancelled' | 'retrying' required

Current fax status

providerstring required

Provider used to send the fax

tostring required

Recipient fax number

fromstring required

Sender fax number

createdAtstring required

ISO timestamp when fax was created

estimatedDeliverystring

Estimated delivery time (ISO timestamp)

Changes