/faxes

POST

/faxes

Request

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Successful response

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.faxlink.ca/afx/v4//faxes' \
--header 'Content-Type: application/json' \
--data '{
    "clientReference": "string",
    "sender": {
        "email": "string",
        "faxNumber": "string"
    },
    "recipients": [
        {
            "faxNumber": "string"
        }
    ],
    "documents": [
        {
            "sourceUrl": "string",
            "contentBase64": "string",
            "fileName": "string",
            "mediaType": "string"
        }
    ],
    "sendAt": "string",
    "callbackUrl": "string",
    "coverPage": {
        "enabled": true,
        "template": "string",
        "toName": "string",
        "toOrganization": "string",
        "fromName": "string",
        "subject": "string",
        "body": "string"
    },
    "numberOfRetries": 0
}'

Response Example

{
    "rfid": "string",
    "clientReference": "string",
    "status": "string",
    "documentCount": 0,
    "createdAt": "string",
    "links": {
        "self": "string"
    }
}

Modified at 2026-09-15 22:26:45

/oauth/token

/faxes/binary