Create Appointment repeat template

Request

Repeat templates store how an Appointment is repeated. Use them in the Repeat an Appointment request or keep them for reuse. The Business User needs the permission to manage the Location.

Security

BearerPartnerUser

Path

location_idintegerrequired

Location ID

Example:4564

Acceptstringrequired

Default:"application/vnd.api.v2+json"

Content-Typestringrequired

Default:"application/json"

Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired

titlestring, <= 50 charactersrequired

Template name

Example:"Every other week on Tuesday"

repeat_modestring(repeat_mode)required

Repeat mode:

day - every day
working_days - Monday to Friday
mon_wed_fri - Monday, Wednesday and Friday
tue_thu - Tuesday and Thursday
week - every week on the days listed
month - every month on the same day
year - every year on the same date

Enum:"day""working_days""mon_wed_fri""tue_thu""week""month""year"

Example:"week"

intervalinteger, >= 0(interval)

Number of periods skipped between repetitions for day, week, month and year (0 - every period, 1 - every other period)

Example:1

daysArray of integers(days)

Days of the week for week mode, required there: 1 - Monday ... 7 - Sunday

Example:

[
  2
]

curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/4564/appointments/duplication_strategies \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Every other week on Tuesday",
    "repeat_mode": "week",
    "interval": 1,
    "days": [
      2
    ]
  }'

Responses

Created

Bodyapplication/json

successboolean

dataobject(Appointment repeat template)

metaArray of any

Response

{
  "success": true,
  "data": {
    "id": 3297,
    "title": "Every other week on Tuesday",
    "interval": 1,
    "repeat_mode": "week",
    "days": [ … ]
  },
  "meta": []
}