---
title: "Perform bulk operations on the status reports"
method: POST
path: "/{custNr}/fax/reports"
tags: ["Fax reports"]
---

# Perform bulk operations on the status reports

`POST /{custNr}/fax/reports`

## Request

- Base URL: `https://faxws.de1.retarus.com/rest/v1`
- URL: `https://faxws.de1.retarus.com/rest/v1/{custNr}/fax/reports`
- Auth: HTTP basic

It is possible to perform bulk operations on the status reports through a
POST on the `/{custNr}/fax/reports` endpoint. The required parameters are:

  * the type of action to be performed
  * A list of Job IDs on which the operation should be performed

Status reports are available for up to 30 days or until deleted.

The maximum number of jobs per POST request is set to 1000.

**Please note**: This endpoint should only be used with a data center specific URL. This endpoint could return an error about unknown job IDs depending on the data center the request is processed by.

## Path parameters

- `custNr` string, required

## Request body

- BulkJobReportsRequestBody: Body of the request for bulk operations on the job reports
  - `action` string, required: Defines the action to be performed on all jobs whose Job ID is provided in the `jobIds` list Possible options are: * DELETE: Bulk delete the requested jobs * GET: Bulk get the requested jobs Both options are case insensitive.
  - `jobIds` string[], required: List of Job IDs to be processed in bulk

## Response `200`

Depending on the request type, this returns a `reports` item containing either:

  * an array of `Fax Report` items for the bulk GET (same as `getAllStatusReports`).
  * an array of `Job Delete Report` items for the bulk DELETE.

- BulkJobReportResponseBody
  - `reports` BulkJobReportResponseBodyItem[]
    - `jobId` string, required: The Job ID.
    - `recipientStatus` FaxRecipientWithStatus[]
      - `number` string, required: The fax recipient's primary number (international format, e.g., +49891234678).
      - `properties` RecipientProperty[], nullable: Personalized data used for the cover page.
        - `key` string, required: Name of the key.
        - `value` string, required: The value assigned to the key.
      - `status` string, required: Job status, e.g., OK or ERROR.
      - `reason` string, required: Explanation of the status.
      - `sentTs` string, date-time: Timestamp which indicates when the fax was sent (in ISO 8601 format).
      - `durationInSecs` integer, required: Duration of the fax transmission until received by the fax recipient.
      - `sentToNumber` string: Number to which the fax was sent.
      - `remoteCsid` string: Fax ID which identifies the fax recipient.
    - `pages` integer: Number of pages in the fax. Only present for responses to a bulk GET.
    - `reference` Reference
      - `customerDefinedId` string: Freely-defined ID string (max. 256 characters).
      - `billingCode` string: Information on the cost center; format is arbitrary (max. 80 characters).
      - `billingInfo` string: Additional data for internal customer accounting (max. 80 characters).
    - `deleted` boolean: Information whether the job report could be deleted. Only present for responses to a bulk DELETE.
    - `reason` string: Missing if deletion was successful, otherwise one of the following reason messages is returned: * NOT_FOUND: No report exists for the given job id. * INTERNAL_ERROR: Unspecified server-side error. Only present for responses to a bulk DELETE.

## Changes

- **2026-11-06** `64e666009b31`: 1 breaking
  - the `reports/items/reason` response's property type changed from `boolean` to `string` for status `200`

[Operation history](https://skmtc.dev/retarus/apis/faxolution-for-applications-fax4a-rest-api/changes/:custNr/fax/reports/post.md)

---

[API](https://skmtc.dev/retarus/apis/faxolution-for-applications-fax4a-rest-api.md) - [All operations](https://skmtc.dev/retarus/apis/faxolution-for-applications-fax4a-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/retarus/apis/faxolution-for-applications-fax4a-rest-api/revisions/64e666009b31?raw)