PUT
/schedule/{scheduleId}Update Schedule
Update Schedule
Implementation Notes:
This method enables you to edit a schedule by providing the scheduleID as an input.
PUT
/schedule/{scheduleId}Parameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
scheduleId | path | integer | Required | Enter your scheduleId |
body | body | object | Optional | none |
» scheduleName | body | string | Optional | Enter schedule name |
» year | body | string | Optional | The year component of the schedule. Use '*' to match any year. |
» month | body | string | Optional | The month component of the schedule. Use '*' to match any month. |
» dow | body | string | Optional | The day of the week component of the schedule. Use '*' to match any day of the week. |
» day | body | string | Optional | The day of the month component of the schedule. Use '*' to match any day of the month. |
» hour | body | string | Optional | The hour component of the schedule. Use '*' to match any hour of the day. |
» minute | body | string | Optional | The minute component of the schedule. Use '*' to match any minute of the hour. |
» seconds | body | string | Optional | The second component of the schedule. Use '*' to match any second of the minute. |
» startDate | body | string(date) | Optional | The start date of the schedule. |
» endDate | body | string(date) | Optional | The end date of the schedule. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Updated | |
| 400 | Bad Request | Bad Request | None |
| 401 | Unauthorized | Authorization Failed | None |
| 429 | Too Many Requests | Too Many Requests | None |
| 500 | Internal Server Error | Internal Server Error | None |
Example Request
# You can also use wget
curl -X PUT http://localhost:3000/schedule/{scheduleId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: API_KEY'
Body parameter
{
"scheduleName": "X-Mas",
"year": "*",
"month": "*",
"dow": "*",
"day": "*",
"hour": "1",
"minute": "00",
"seconds": "00",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
Example responses
200 Response
{
"message": "Schedules details updated successfully"
}
Need Support?
Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.