PUT
/scheduleUpdate Schedule
This endpoint enables you to update the existing configuration by using the scheduleId.
PUT
/scheduleParameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
» scheduleId | body | number | Required | Specifies the ID of the schedule to be updated. |
» scheduleName | body | string | Required | Specifies the name of the schedule. |
» shopId | body | number | Required | Specifies the shop ID to be scheduled. |
» year | body | string | Required | Specifies the years for scheduling. |
» month | body | string | Required | Specifies the months for scheduling. |
» dayOfWeek | body | string | Optional | Specifies the days of the week. |
» day | body | string | Required | Specifies the days of the month. |
» hour | body | string | Required | Specifies the hour of the day (0-23) when the shop is triggered. |
» minute | body | string | Required | Specifies the minute (0-59) within the hour when the shop is triggered. |
» startDate | body | string(date) | Required | Specifies when the schedule should start. |
» endDate | body | string(date) | Required | Specifies when the schedule should end. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schedule updated successfully | |
| 400 | Bad Request | Bad Request | None |
| 401 | Unauthorized | Authentication Failed or Account validity Expired | 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 /schedule \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'Body parameter
{
"scheduleId": 123,
"scheduleName": "Updated Schedule",
"shopId": 1,
"year": "2025",
"month": "1,2,3",
"dayOfWeek": "*",
"day": "1-5",
"hour": "10",
"minute": "30",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}Example responses
200 Response
{
"message": "Schedule Updated Successfully",
"scheduleId": 123
}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.