Update a schedule | Cata API

curl -X PUT http://localhost:8080/api/v1/schedules/1514 \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "scheduleType": "recurring",
  "cronExpr": "string",
  "timezone": "string",
  "oneTimeAt": "1990-12-24T01:43:39.202Z",
  "publishMode": "all_mapped",
  "draftIds": [
    8876,
    6930
  ],
  "outletIds": [
    "6b6d111f-3805-16b0-eb60-1e0fc2510b57",
    "1330dd96-3b1d-9021-1d3a-ed1635d968e4"
  ]
}'

{
  "code": 1784,
  "isSuccess": false,
  "message": "string",
  "schedule": {
    "id": 900,
    "name": "string",
    "scheduleType": "one_time",
    "cronExpr": "string",
    "timezone": "string",
    "oneTimeAt": "1946-09-24T02:54:32.834Z",
    "publishMode": "specific_drafts",
    "draftIds": [
      3970,
      9537
    ],
    "outletIds": [
      "0e95f95f-7a7c-ecd8-3202-48ff98b2820b",
      "036e714b-9718-1b5a-c20e-c6b868ccfb6d"
    ],
    "status": "paused",
    "lastRunAt": "2000-07-07T11:44:09.998Z",
    "nextRunAt": "1958-01-21T03:10:49.531Z",
    "createdAt": "1975-11-08T02:24:22.211Z",
    "updatedAt": "1950-12-11T20:07:28.370Z"
  }
}

Merge-update fields and recompute next run time.

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

scheduleIdstringRequired

Request

This endpoint expects an object.

namestringRequired

scheduleTypestringRequired

cronExprstringRequired

timezonestringRequired

oneTimeAtdatetimeRequired

publishModestringRequired

draftIdslist of integersRequired

outletIdslist of stringsRequired

Response

codeinteger

isSuccessboolean

messagestring

scheduleobject

Errors

400

Bad Request Error

404

Not Found Error