v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Configuration Schedules

Create a schedule

Use this endpoint to create a cron-based reconciliation schedule for automatic matching within a context.

post/v1/contexts/{contextId}/schedules

Path parameters

contextIdstring required

The unique identifier of the reconciliation context.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Request body

cronExpressionstring required

Cron expression defining the schedule frequency

enabledboolean

Whether the schedule should be active immediately

Example request

{
  "cronExpression": "0 0 * * *",
  "enabled": true
}

Response

Schedule created.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

idstring uuid

Unique identifier for the schedule

contextIdstring uuid

Context this schedule belongs to

cronExpressionstring

Cron expression defining the schedule

enabledboolean

Whether the schedule is active

lastRunAtstring date-time

Last successful run time in RFC 3339 format

nextRunAtstring date-time

Next scheduled run time in RFC 3339 format

createdAtstring date-time

Creation timestamp in RFC 3339 format

updatedAtstring date-time

Last update timestamp in RFC 3339 format

Example response

{
  "id": "019c96a0-2b20-7123-9a1b-2c3d4e5f6a7b",
  "contextId": "019c96a0-2a10-7dfe-b5c1-8a1b2c3d4e5f",
  "cronExpression": "0 0 * * *",
  "enabled": true,
  "lastRunAt": "2025-01-15T10:30:00Z",
  "nextRunAt": "2025-01-16T00:00:00Z",
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z"
}