Pause a schedule

PATCH

http://localhost:8080/api/v1/schedules/:scheduleId/pause

PATCH

/api/v1/schedules/:scheduleId/pause

1 curl -X PATCH http://localhost:8080/api/v1/schedules/1514/pause \
2      -H "X-Api-Key: <apiKey>"

1 {
2   "code": 1784,
3   "isSuccess": false,
4   "message": "string",
5   "schedule": {
6     "id": 900,
7     "name": "string",
8     "scheduleType": "one_time",
9     "cronExpr": "string",
10     "timezone": "string",
11     "oneTimeAt": "1946-09-24T02:54:32.834Z",
12     "publishMode": "specific_drafts",
13     "draftIds": [
14       3970,
15       9537
16     ],
17     "outletIds": [
18       "0e95f95f-7a7c-ecd8-3202-48ff98b2820b",
19       "036e714b-9718-1b5a-c20e-c6b868ccfb6d"
20     ],
21     "status": "paused",
22     "lastRunAt": "2000-07-07T11:44:09.998Z",
23     "nextRunAt": "1958-01-21T03:10:49.531Z",
24     "createdAt": "1975-11-08T02:24:22.211Z",
25     "updatedAt": "1950-12-11T20:07:28.370Z"
26   }
27 }

Stops the schedule from executing on its next run.

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

scheduleIdstringRequired

Response

codeinteger

messagestring

scheduleobject

isSuccessboolean

Errors

400

Bad Request Error

404

Not Found Error