PUT/schedules/{scheduleId}

Update Schedule

Standard API endpoint for Update Schedule.

PUT/schedules/{scheduleId}

Mandatory Fields

scheduleId
body
scheduleName
shopId
year
month
dow
day
hour
minute
startDate
endDate

Note

For any technical assistance or feature requests, please contact our API support team.

Important Notes

Always use HTTPS for API requests.
Access tokens are valid for a limited time and should be refreshed periodically.
Rate limiting applies to all endpoints to ensure system stability.

Parameter Details

Name	In	Type	Required	Description
`scheduleId`	path	`integer`	Required	Unique identifier for the schedule to update
`body`	body	`object`	Required	none
`» 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.

All parameters should be formatted according to the types specified in the table above.

Responses

Status	Meaning	Description	Schema
200	OK	Schedule updated successfully	`Inline`
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

Response Notes

The response will include a status field indicating success or failure, along with the requested data or relevant error messages. Standard HTTP status codes are used to indicate the outcome of the request.

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."
}

PreviousGet Schedule By Id

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