Update Schedule

PATCH /schedules/{schedule_id}

Update Schedule

cURL

curl --request PATCH \
  --url https://api.example.com/schedules/{schedule_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "cron_expr": "<string>",
  "endpoint": "<string>",
  "method": "<string>",
  "description": "<string>",
  "payload": {},
  "timezone": "<string>",
  "timeout_seconds": 43200,
  "max_retries": 5,
  "retry_delay_seconds": 1800
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "method": "<string>",
  "endpoint": "<string>",
  "cron_expr": "<string>",
  "timezone": "<string>",
  "timeout_seconds": 123,
  "max_retries": 123,
  "retry_delay_seconds": 123,
  "enabled": true,
  "description": "<string>",
  "payload": {},
  "next_run_at": 123,
  "created_at": 123,
  "updated_at": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

schedule_id · string · required

Body

application/json

name · string | null

Maximum string length: 255

cron_expr · string | null

Maximum string length: 128

endpoint · string | null

Maximum string length: 512

method · string | null

Maximum string length: 10

description · string | null

Maximum string length: 1024

payload · Payload · object

timezone · string | null

Maximum string length: 64

timeout_seconds · integer | null

Required range: 1 <= x <= 86400

max_retries · integer | null

Required range: 0 <= x <= 10

retry_delay_seconds · integer | null

Required range: 1 <= x <= 3600

Response

200

application/json

Successful Response

id · string · required

name · string · required

method · string · required

endpoint · string · required

cron_expr · string · required

timezone · string · required

timeout_seconds · integer · required

max_retries · integer · required

retry_delay_seconds · integer · required

enabled · boolean · required

description · string | null

payload · Payload · object

next_run_at · integer | null

created_at · integer | null

updated_at · integer | null