Skip to main content
PATCH
Update a schedule

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
string

Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409, and an idempotency storage failure returns 500. These refusals are problem documents.

Path Parameters

contextId
string<uuid>
required

The unique identifier of the reconciliation context. Context ID

scheduleId
string<uuid>
required

The unique identifier of the schedule. Schedule ID

Body

application/json

Fields to update

cronExpression
string

Cron expression (5-field) defining when the reconciliation runs.

Maximum string length: 100
Example:

"0 6 * * *"

enabled
boolean

Whether the schedule is active.

Example:

false

Response

Schedule updated.

contextId
string
required

Identifier of the context this schedule belongs to.

Example:

"550e8400-e29b-41d4-a716-446655440000"

createdAt
string
required

Creation timestamp in RFC 3339 format.

Example:

"2025-01-15T10:30:00Z"

cronExpression
string
required

Cron expression (5-field) defining when the reconciliation runs.

Example:

"0 0 * * *"

enabled
boolean
required

Whether the schedule is active.

Example:

true

id
string
required

Unique identifier of the schedule.

Example:

"550e8400-e29b-41d4-a716-446655440000"

updatedAt
string
required

Last update timestamp in RFC 3339 format.

Example:

"2025-01-15T10:30:00Z"

lastRunAt
string

Timestamp of the last successful run in RFC 3339 format; omitted if it has never run.

Example:

"2025-01-15T10:30:00Z"

nextRunAt
string

Timestamp of the next scheduled run in RFC 3339 format; omitted when disabled.

Example:

"2025-01-16T00:00:00Z"