Scheduler Service
Update a schedule

1min
PUT
/schedules/{scheduleId}
Path Parameters
scheduleId
string
*
Header Parameters
X-COREOS-ACCESS
string
*
X-COREOS-APPID
string
*
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
Body Parameters
body
UpdateScheduleRequest
*
endpointUrl
string
*
signatureKey
string
*
payload
object
startDate
string
*
endDate
string
cron
string
*
isActive
boolean
Responses
200
Successful operation
UpdateScheduleResponse
schedule
object
*
error
object
*
400
Bad Request
ScheduleErrorResponse
Example
{"schedule":{},"error":{"code":"200110023003","description":"Bad Request","additionalInfo":"EndDate can not be before StartDate"}}
schedule
object
*
error
object
*
Curl
JS
Ruby
Python
curl --location --globoff --request PUT '/schedules/{scheduleId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "endpointUrl": "",
  "signatureKey": "",
  "startDate": "",
  "cron": ""
}'
curl --location --globoff --request PUT '/schedules/{scheduleId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "endpointUrl": "",
  "signatureKey": "",
  "startDate": "",
  "cron": ""
}'
Responses
200
400
// Successful operation 
{
  "schedule": {
    "scheduleId": "schedule:89d03717-b21f-49bc-b3c9-cd1924cee5a2",
    "tenantId": "os1decs",
    "appId": "dispatch-fpa",
    "endpointUrl": "https://example.com/trigger",
    "signatureKey": "abcdefghijklmnopqrstuvwxyz0123456789",
    "payload": {},
    "startDate": "2023-08-30",
    "endDate": "2023-08-30",
    "cron": "* * * * *",
    "isActive": true,
    "TTL": 1695105095
  },
  "error": {}
}
// Successful operation 
{
  "schedule": {
    "scheduleId": "schedule:89d03717-b21f-49bc-b3c9-cd1924cee5a2",
    "tenantId": "os1decs",
    "appId": "dispatch-fpa",
    "endpointUrl": "https://example.com/trigger",
    "signatureKey": "abcdefghijklmnopqrstuvwxyz0123456789",
    "payload": {},
    "startDate": "2023-08-30",
    "endDate": "2023-08-30",
    "cron": "* * * * *",
    "isActive": true,
    "TTL": 1695105095
  },
  "error": {}
}
﻿
﻿
Updated 20 Sep 2024
Did this page help you?
Get a schedule by ID
List Executions of a schedule