Skip to main content
PATCH
/
v1
/
config
/
contexts
/
{contextId}
/
schedules
/
{scheduleId}
Update a schedule
curl --request PATCH \
  --url https://matcher.sandbox.lerian.net/v1/config/contexts/{contextId}/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cronExpression": "0 6 * * *",
  "enabled": false
}
'
{
  "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"
}

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.

Path Parameters

​
contextId
string
required

The unique identifier of the reconciliation context.

​
scheduleId
string
required

The unique identifier of the schedule.

Body

application/json

Fields to update

Payload for updating a reconciliation schedule

​
cronExpression
string

Updated cron expression

Maximum string length: 100
Example:

"0 6 * * *"

​
enabled
boolean

Updated enabled status

Example:

false

Response

Schedule updated

Cron-based reconciliation schedule

​
id
string<uuid>

Unique identifier for the schedule

Example:

"019c96a0-2b20-7123-9a1b-2c3d4e5f6a7b"

​
contextId
string<uuid>

Context this schedule belongs to

Example:

"019c96a0-2a10-7dfe-b5c1-8a1b2c3d4e5f"

​
cronExpression
string

Cron expression defining the schedule

Maximum string length: 100
Example:

"0 0 * * *"

​
enabled
boolean

Whether the schedule is active

Example:

true

​
lastRunAt
string<date-time>

Last successful run time in RFC 3339 format

Example:

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

​
nextRunAt
string<date-time>

Next scheduled run time in RFC 3339 format

Example:

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

​
createdAt
string<date-time>

Creation timestamp in RFC 3339 format

Example:

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

​
updatedAt
string<date-time>

Last update timestamp in RFC 3339 format

Example:

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