Saltar al contenido principal
POST
Create a schedule

Autorizaciones

Authorization
string
header
requerido

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

Encabezados

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.

Parámetros de ruta

contextId
string<uuid>
requerido

The unique identifier of the reconciliation context. Context ID

Cuerpo

application/json

Schedule details

cronExpression
string
requerido

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

Required string length: 1 - 100
Ejemplo:

"0 0 * * *"

enabled
boolean

Whether the schedule is active. Defaults to true when omitted.

Ejemplo:

true

Respuesta

Schedule created.

contextId
string
requerido

Identifier of the context this schedule belongs to.

Ejemplo:

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

createdAt
string
requerido

Creation timestamp in RFC 3339 format.

Ejemplo:

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

cronExpression
string
requerido

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

Ejemplo:

"0 0 * * *"

enabled
boolean
requerido

Whether the schedule is active.

Ejemplo:

true

id
string
requerido

Unique identifier of the schedule.

Ejemplo:

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

updatedAt
string
requerido

Last update timestamp in RFC 3339 format.

Ejemplo:

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

lastRunAt
string

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

Ejemplo:

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

nextRunAt
string

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

Ejemplo:

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