Saltar al contenido principal
POST
Cancel a recurring series

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Replaying the same key with a divergent method, URL or body is PIX-0031 @ 412.

Required string length: 1 - 64

Parámetros de ruta

recurrence_id
string<uuid>
requerido

Series identifier.

Ejemplo:

"01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0"

Respuesta

OK

cancelledOccurrences
integer<int64>
requerido

How many occurrences this request moved to CANCELLED. It counts ONLY the ones that were still PENDING, and it is the row count of the write itself rather than a census taken beforehand.

Ejemplo:

5

recurrenceId
string
requerido

The series that was stopped.

Ejemplo:

"01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0"

skippedOccurrences
integer<int64>
requerido

How many materialized occurrences this request did not change, because they were not PENDING. Together with cancelledOccurrences it accounts for every occurrence the series had.

Ejemplo:

1

status
enum<string>
requerido

The series' status after the operation. Always CANCELLED on a 200 -- a series that could not be stopped answers PIX-0765 instead of reporting an unchanged status.

Opciones disponibles:
ACTIVE,
COMPLETED,
CANCELLED
Ejemplo:

"CANCELLED"