Create a publish schedule | Cata API

curl -X POST http://localhost:8080/api/v1/schedules \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Monday breakfast publish",
  "scheduleType": "recurring",
  "publishMode": "all_mapped",
  "outletIds": [
    "5af196ce-e70e-e254-b289-1bd0af19f9b5",
    "5317819f-55f6-cb46-8607-d7da351ae7b1"
  ],
  "cronExpr": "0 8 * * 1",
  "timezone": "Asia/Singapore",
  "oneTimeAt": "2024-10-26T21:27:05.021Z",
  "draftIds": [
    5548,
    2741
  ]
}'

{
  "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"
  }
}

Create a new one-time or recurring publish schedule. The service computes nextRunAt based on the schedule type and timezone.

Authentication

X-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

namestringRequired

scheduleTypestringRequired

publishModestringRequired

outletIdslist of stringsRequired

cronExprstringRequired

timezonestringRequired

oneTimeAtdatetimeRequired

draftIdslist of integersRequired

Response

Created

codeinteger

isSuccessboolean

messagestring

scheduleobject

Errors

400

Bad Request Error