POST/schedules

Create Schedule

This endpoint allows you to create a new create schedule entry in the system.

POST/schedules

Mandatory Fields

body

Optional Fields

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
`body`	body	`object`	Required	none
`» scheduleName`	body	`string`	Optional	Name of the schedule.
`» shopId`	body	`integer`	Optional	Unique ID generated when creating the shop.
`» year`	body	`string(date)`	Optional	Year(s) the schedule runs.
`» month`	body	`string`	Optional	Month(s) the schedule runs.
`» dow`	body	`string`	Optional	Days of the week the schedule runs.
`» day`	body	`string`	Optional	Days of the month the schedule runs.
`» hour`	body	`string`	Optional	Hours the schedule runs.
`» minute`	body	`string`	Optional	Minutes the schedule runs.
`» startDate`	body	`string(date)`	Optional	Start date of the schedule (UTC format).
`» endDate`	body	`string(date)`	Optional	End date of the schedule. If undefined, runs indefinitely.

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

Responses

Status	Meaning	Description	Schema
201	Created	Created	`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 POST /schedules \
  -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": 0,
  "year": "*",
  "month": "*",
  "dow": "*",
  "day": "*",
  "hour": "*",
  "minute": "00",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24"
}

Example responses

{
  "message": "Schedule created successfully.",
  "scheduleId": 1
}

PreviousDelete Shop

NextList Schedules

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