POST/replay-jobs/{id}/cancel

Cancel a replay job

Requires Bearer authentication. See Authentication.

Request body

No fields.

Responses

200 200

Field Type Description

idrequired string (uuid) —

tenantIdrequired string (uuid) —

customerAccountIdrequired string (uuid) —

requestedByrequired string (uuid) —

namerequired string —

scopeTyperequired enum (5) —

scopeDefinitionrequired ScopeDefinition —

typerequired enum (5) —

filtersrequired ScopeFilters —

`destinationIds`	string (uuid)[]	—
`eventTypes`	string[]	—
`startTime`	string (date-time)	—
`endTime`	string (date-time)	—
`deliveryStatuses`	enum (6)[]	—
`environment`	"PRODUCTION" \| "STAGING" \| "DEVELOPMENT"	—

statusrequired enum (6) —

totalCountrequired number —

succeededCountrequired number —

failedCountrequired number —

remainingCountrequired number —

rateLimitrequired number —

startedAtrequired string (date-time) —

completedAtrequired string (date-time) —

cancelledAtrequired string (date-time) —

createdAtrequired string (date-time) —

400 400

Field Type Description

errorrequired object —

`code`required	string	—
`message`required	string	—
`details`	any	—

404 404

Field Type Description

errorrequired object —

`code`required	string	—
`message`required	string	—
`details`	any	—

Errors

Errors use the standard envelope. See Errors for codes, status mappings, and retry semantics.

{ "id": "00000000-0000-0000-0000-000000000000", "tenantId": "00000000-0000-0000-0000-000000000000", "customerAccountId": "00000000-0000-0000-0000-000000000000", "requestedBy": "00000000-0000-0000-0000-000000000000", "name": "string", "scopeType": "FAILED_DELIVERIES", "scopeDefinition": { "type": "FAILED_DELIVERIES", "filters": { "destinationIds": [ "00000000-0000-0000-0000-000000000000" ], "eventTypes": [ "string" ], "startTime": "2026-06-24T18:04:16.296Z", "endTime": "2026-06-24T18:04:16.296Z", "deliveryStatuses": [ "PENDING" ], "environment": "PRODUCTION" } }, "status": "PENDING", "totalCount": 0, "succeededCount": 0, "failedCount": 0, "remainingCount": 0, "rateLimit": 0, "startedAt": "2026-06-24T18:04:16.296Z", "completedAt": "2026-06-24T18:04:16.296Z", "cancelledAt": "2026-06-24T18:04:16.296Z", "createdAt": "2026-06-24T18:04:16.296Z" }