Skip to main content
POST
Cancel a recurring series

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

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

Path Parameters

recurrence_id
string<uuid>
required

Series identifier.

Example:

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

Response

OK

cancelledOccurrences
integer<int64>
required

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.

Example:

5

recurrenceId
string
required

The series that was stopped.

Example:

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

skippedOccurrences
integer<int64>
required

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.

Example:

1

status
enum<string>
required

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.

Available options:
ACTIVE,
COMPLETED,
CANCELLED
Example:

"CANCELLED"