Add recurrence to a shift

Turns a shift into a recurring series by attaching a recurrence rule.

POST

/v1/shifts/{id}/recurrence

Authorizations

• oauth2
  shifts:write

Request Body^required

Media typeapplication/json

object

freq

required

string

Allowed values: daily weekly monthly

interval

integer

default: 1 >= 1 <= 99

byWeekday

Array<integer>

until

string

count

integer

>= 2 <= 500

Example

{
  "freq": "daily",
  "interval": 1,
  "byWeekday": [
    0
  ],
  "until": "string",
  "count": 0
}

Responses

201

The created recurring series

Media typeapplication/json

object

item

required

object

id

required

integer

>= -9007199254740991 <= 9007199254740991

userId

required

integer

>= -9007199254740991 <= 9007199254740991

freq

required

string

Allowed values: daily weekly monthly

interval

required

integer

>= -9007199254740991 <= 9007199254740991

byWeekday

Array

until

string

count

integer

>= -9007199254740991 <= 9007199254740991

anchorDate

required

string

Example

{
  "item": {
    "id": 0,
    "userId": 0,
    "freq": "daily",
    "interval": 0,
    "byWeekday": [
      0
    ],
    "until": "string",
    "count": 0,
    "anchorDate": "string"
  }
}