PUT
/schedules/{scheduleId}Update Schedule
Updates the details of a schedule identified by the provided scheduleId.
PUT
/schedules/{scheduleId}Parameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
scheduleId | path | integer | Required | Unique identifier for the schedule to update |
» scheduleName | body | string | Required | Name of the schedule. |
» shopId | body | integer | Required | Unique identifier for the shop in the schedule. |
» year | body | string | Required | Year for the schedule. |
» month | body | string | Required | Month for the schedule. |
» dow | body | string | Required | Day of the week for the schedule. |
» day | body | string | Required | Day of the month for the schedule. |
» hour | body | string | Required | Hour for the schedule. |
» minute | body | string | Required | Minute for the schedule. |
» startDate | body | string(date) | Required | Start date of the schedule. |
» endDate | body | string(date) | Required | End date of the schedule. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schedule updated successfully | |
| 400 | Bad Request | Bad Request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden - Access denied | None |
| 404 | Not Found | Schedule not found | 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 /schedules/{scheduleId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-d '{"scheduleName":"string","shopId":0,"year":"string","month":"string","dow":"string","day":"string","hour":"string","minute":"string","startDate":"string","endDate":"string"}'
Body parameter
{
"scheduleName": "My schedule",
"shopId": 1,
"year": "*",
"month": "*",
"dow": "*",
"day": "*",
"hour": "*",
"minute": "20",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
Example responses
200 Response
{
"message": "Schedule 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.