Update Schedule

PUT /v1/schedules/{id}

Error

A valid request URL is required to generate request examples

200

{
  "id": "sch_TW2qf5b1Ra7mP3Xy",
  "cron_expr": "<string>",
  "url": "<string>",
  "method": "GET",
  "timezone": "<string>",
  "enabled": true,
  "next_trigger": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "human_readable": "<string>",
  "actions": [
    "pause"
  ],
  "payload": {},
  "headers": {},
  "last_triggered": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

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

Headers

X-Request-Id · string

Optional client request ID. Echoed back on response.

Content-Type · string · required

Pattern: ^application/json(;.*)?$

Path Parameters

id · string · required

Pattern: ^sch_[A-Za-z0-9_-]+$

Example:

"sch_TW2qf5b1Ra7mP3Xy"

Body

application/json

cron_expr · string

url · string<uri>

method · enum<string>

Available options: GET, POST, PUT, PATCH, DELETE

payload · object

headers · object

Show child attributes

timezone · string

enabled · boolean

Response

200

application/json

Schedule updated

id · string · required

Pattern: ^sch_[A-Za-z0-9_-]+$

Example:

"sch_TW2qf5b1Ra7mP3Xy"

cron_expr · string · required

url · string<uri> · required

method · enum<string> · required

Available options: GET, POST, PUT, PATCH, DELETE

timezone · string · required

enabled · boolean · required

next_trigger · string<date-time> · required

created_at · string<date-time> · required

human_readable · string · required

actions · enum<string>[] · required

Available options: pause, resume, delete

payload · object

headers · object

Show child attributes

last_triggered · string<date-time> | null