Skip to main content
POST
Bulk dispatch exceptions

Authorizations

Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency-Key
string

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Body

application/json

Bulk dispatch payload

Request payload for bulk dispatching exceptions

exceptionIds
string[]
required

List of exception IDs to dispatch (maximum 100)

Required array length: 1 - 100 elements
targetSystem
string
required

Target external system

Maximum string length: 255
Example:

"JIRA"

queue
string

Target queue within the external system

Maximum string length: 255

Response

Bulk operation completed (check response for partial failures).

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

Response from a bulk operation with success and failure details

succeeded
string[]

List of exception IDs that were processed successfully

failed
object[]

List of failures with exception IDs and error messages

total
integer

Total number of exceptions in the request

Example:

10