Fax jobs

Send a fax

Changed on Nov 6, 2026

This method is used to prepare fax jobs to be transferred for processing. If a valid FaxJobRequest has been received by the Webservice, the Webservice sends a Job ID back that must be specified by the client when querying the job status.

post/{custNr}/fax

Request

Base URL
https://faxws.de1.retarus.com/rest/v1
Auth
HTTP basic

Path parameters

custNrstring required

Your Retarus Customer Number (e.g. 99999TE).

Request body

Example request

{
  "reference": {
    "customerDefinedId": "2022-04-7T11:04:37.057Z_customerDefinedId",
    "billingCode": "2022-04-7T11:04:37.057Z_billingCode",
    "billingInfo": "2022-04-7T11:04:37.057Z_billingInfo"
  },
  "recipients": [
    {
      "number": "0012012051598",
      "properties": [
        {
          "key": "key123",
          "value": "value123"
        }
      ]
    }
  ],
  "documents": [
    {
      "name": "test-document-inline-byte-array.txt",
      "reference": "http://mydomain.retarus.com/my-path/mydocument.pdf",
      "data": "SGVsbG8sIHRoaXMgaXMgYSB0ZXN0aW5nIGRvY3VtZW50IGJvZHkgY3JlYXRlZCBmb3IgOTk5OTlURQ=="
    }
  ],
  "transportOptions": {
    "csid": "test-csid"
  },
  "renderingOptions": {
    "coverpageTemplate": "coverpage-default.ftl.html",
    "overlay": {
      "name": "LetterHead"
    },
    "header": "%tz=CEST Testfax: CSID: %C Recipient number: %# Date: %d.%m.%Y %H:%M %z"
  },
  "statusReportOptions": {
    "reportPurgeTs": "2022-11-03T20:14:37.098+02:00",
    "reportMail": {
      "successAddress": "john.doe@retarus.com",
      "failureAddress": "jane.doe@retarus.com",
      "attachedFaxImageMode": "SUCCESS_ONLY"
    },
    "httpStatusPush": {
      "targetUrl": "https://retarus.com/test-path/test-target",
      "principal": "none",
      "credentials": "none"
    }
  }
}

Response

Fax job submitted successfully

jobIdstring required

Example response

{
  "jobId": "FJKQQUVF1J0IADYARQEXKC"
}

Changes

Nov 6, 202664e666009b31 Revision changes
- breaking
  the request property // became not nullable
- breaking
  the request property // became not nullable
- breaking
  the request property // became not nullable
- breaking
  the request property / became not nullable
- breaking
  the request property / became not nullable
- breaking
  the request property // became not nullable
- breaking
  the request property // became not nullable
- breaking
  removed the enum value ALL_PAGES, of the request property //
- breaking
  the // request property type changed from string to string null, and format from no format to uri
- info
  added the new ALL_PAGES enum value to the request property //

Operation history