Create a recurring order

Create a new recurring order. •'Frequence': Either '0' (Daily), '1' (Weekly), '2' (Monthly) or '99' (Never). •'DaysOfWeek': An array of string that contains the days of the week. Sunday is '0', then Monday '1', etc. Should be left empty when 'RecurrenceFrenquence is 'Daily'. •'DaysOfMonth': An array of string that contains the CRON template for the day of the month. Must be a value that comes from the 'monthly-repeat-options' endpoint. Should be left empty when 'RecurrenceFrenquence is 'Daily' or 'Weekly'. Note that Basic Authentication is required for all requests as such, make sure to provide the Authorization header with a valid value.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

[Optional] Sending 'true' will automatically start the recurring order once created. Default value is 'false'.

Body Params

The recurring order configuration

string
required
length ≥ 1
int32
enum
required

[0 - 'Daily', 1 - 'Weekly', 2 - 'Monthly', 99 - 'Never']

Allowed:
date-time
required
date-time | null
string
required
int32
string
required
string | null
string | null
int32
1 to 2147483647
templates
array of objects | null
templates
inclusionDates
array of date-times | null
inclusionDates
inclusionCalendarIds
array of int32s | null
inclusionCalendarIds
skipDates
array of date-times | null
skipDates
skipDatesCalendarIds
array of int32s | null
skipDatesCalendarIds
daysOfWeek
array of strings | null
daysOfWeek
daysOfMonth
array of strings | null
daysOfMonth
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

500

An error occurred when trying to create the recurring order

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json