PUT/schedule

Update Schedule

This endpoint allows updating an existing schedule using its scheduleId.

PUT/schedule

Optional Fields

Implementation Notes

This endpoint allows updating an existing schedule using its scheduleId.

Parameter Details

Name	In	Type	Required	Description
`body`	body	`object`	Required	none
`» scheduleId`	body	`number`	Required	none
`» scheduleName`	body	`string`	Required	none
`» shopId`	body	`number`	Required	none
`» year`	body	`string`	Required	none
`» month`	body	`string`	Required	none
`» dow`	body	`string`	Optional	none
`» day`	body	`string`	Required	none
`» hour`	body	`string`	Required	none
`» minute`	body	`string`	Required	none
`» startDate`	body	`string(date)`	Required	none
`» endDate`	body	`string(date)`	Required	none

Responses

Status	Meaning	Description	Schema
200	OK	Schedule updated successfully	`Inline`
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",
  "dow": "*",
  "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
}

PreviousGet Schedule

NextDelete Schedule

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.

Contact Support