Send a fax

Developing

POST

/domains/{domain}/users/{user}/faxes

Last modified:2026-10-08 14:06:55

OperationId:SendFax

Sends a document as a fax from one of the user's fax numbers, optionally with a cover page. The fax is accepted at once and sent in the background: the response is the stored fax with status pending (or error when the vendor refused it). Poll the fax, or list the mailbox, to follow it to success or error.

To add a cover page, send cover-page fields; the template that applies to the user is filled in (see the cover page endpoints). In a multipart request send them as cover-page[subject] and so on. Fails with 409 when a cover page is asked for and none is set up.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params multipart/form-dataRequired

Responses

🟢202Accepted

application/json

The fax, accepted for sending.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠409

🟠413

🟠415

🔴501

🔴502Bad Gateway

🔴503Service Unavailable

🔴507

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/acme.example.com/users/1001/faxes' \
--header 'Authorization: Bearer <token>' \
--form 'file=@""' \
--form 'caller-id="15551234567"' \
--form 'destination="15557654321"' \
--form 'cover-page=""'

Response Example

202 - Success Example

{
    "fax-id": "fax-out17282913110519",
    "direction": "outbound",
    "status": "pending",
    "error-message": "",
    "remote-number": "15557654321",
    "local-number": "15551234567",
    "remote-name": "",
    "pages": null,
    "vendor": "faxback",
    "datetime": "2026-10-07T18:05:11Z",
    "file-access-url": "https://core1.example.com/ns-api/v2/domains/acme.example.com/users/1001/faxes/fax-17282912340042/play?expires=1791489731&signature=...",
    "thumbnail-url": "https://core1.example.com/ns-api/v2/domains/acme.example.com/users/1001/faxes/fax-17282912340042/thumbnail?expires=1791489731&signature=..."
}

Modified at 2026-10-08 14:06:55

List faxes

Delete faxes in bulk