Skip to main content
POST
/
v1
/
fax
/
send
JavaScript
import BlueHive from '@bluehive/sdk';

const client = new BlueHive({
  apiKey: 'My API Key',
});

const response = await client.fax.send({
  document: { content: 'content', contentType: 'application/pdf' },
  to: 'to',
});

console.log(response.id);
{
  "id": "<string>",
  "status": "queued",
  "provider": "<string>",
  "to": "<string>",
  "from": "<string>",
  "createdAt": "<string>",
  "estimatedDelivery": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key for accessing BlueHive API endpoints. Format: "ApiKey <your-api-key>" or "Bearer <your-api-key>"

Body

application/json
​
to
string
required

Recipient fax number (E.164 format preferred)

​
document
object
required
​
from
string

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

​
subject
string

Subject line for the fax

​
provider
string

Optional provider override (uses default if not specified)

Response

Default Response

​
id
string
required

Unique fax identifier

​
status
enum<string>
required

Current fax status

Available options:
queued,
dialing,
sending,
delivered,
failed,
cancelled,
retrying
​
provider
string
required

Provider used to send the fax

​
to
string
required

Recipient fax number

​
from
string
required

Sender fax number

​
createdAt
string
required

ISO timestamp when fax was created

​
estimatedDelivery
string

Estimated delivery time (ISO timestamp)

⌘I