PUT
/schedule/{scheduleId}/Update Schedule
Update schedule
Implementation Notes
This API allows users to edit an existing schedule for running a shop at specific times. Users can define scheduling parameters, delivery mode, and execution settings.
PUT
/schedule/{scheduleId}/Parameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
scheduleId | path | integer | Required | Enter your scheduleId |
body | body | object | Required | none |
» shopId | body | integer | Optional | Unique shop ID associated with the schedule. |
» scheduleName | body | string | Optional | Name of the schedule. |
» shopType | body | integer | Optional | The type of shop. |
» fetchType | body | integer | Optional | Location where results are stored. |
» year | body | string | Optional | Years the schedule should run. "*" means all years. |
» month | body | string | Optional | Months the schedule should run. "*" means all months. |
» dow | body | string | Optional | Days of the week the schedule should run. "*" means all days. |
» day | body | string | Optional | Days of the month the schedule should run. "*" means all days. |
» hour | body | string | Optional | Hours of the day the schedule should run. "*" means all hours. |
» minute | body | string | Optional | Minutes of the hour the schedule should run. "*" means all minutes. |
» startDate | body | string(date) | Optional | The date when the schedule starts (YYYY-MM-DD). |
» endDate | body | string(date) | Optional | The date when the schedule ends (YYYY-MM-DD). |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | |
| 400 | Bad Request | Bad Request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | 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 https://api.events.example.com/api/v1/schedule/{scheduleId}/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Body parameter
{
"shopId": 0,
"scheduleName": "",
"shopType": 0,
"fetchType": 0,
"year": "*",
"month": "*",
"dow": "*",
"day": "*",
"hour": "*",
"minute": "*",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
Example responses
200 Response
{
"message": "Schedule updated successfully.",
"scheduleId": 67
}
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.