Sign in
SessionRecurrenceGroups

Update a SessionRecurrenceGroup

This endpoint updates a SessionRecurrenceGroup.

put/shop/recurrence-groups/{recurrenceGroupId}

Path parameters

recurrenceGroupIdstring object-id required

Identifier of the session recurrence group. Recurrence groups represent a series of recurring class or session instances; this ID lets you update the series (e.g. cancel future occurrences, change capacity) or delete it outright.

Request body

namestring

An option name for the recurrence group.

practitioner_idstring

The practitioner who leads the sessions in this group.

room_idstring

The room where the sessions in this group take place.

weekdaysstring[]

The weekdays sessions in this group take place.

start_timestring

The start time of each occurrence in this group, in 24 hour format.

capacityinteger

The capacity of each session in this group.

recurrence_startstring date nullable

The start date of the recurrence group.

recurrence_endstring date nullable

The end date of the recurrence group.

Example request

{
  "name": "Mondays with Adrienne",
  "practitioner_id": "5f184bb0b6ecff2e8157bf27",
  "room_id": "5dcb47800000000000000010",
  "weekdays": [
    "monday"
  ],
  "start_time": "16:00",
  "start_times": [
    {
      "value": "12:00"
    }
  ],
  "capacity": 12,
  "recurrence_start": "2021-04-10",
  "recurrence_end": "2021-05-10"
}

Response

The recurrence group was successfully updated.

Example response

{
  "data": {
    "capacity": 12,
    "id": "609bd745e4358066f7061d82",
    "name": "Mondays with Adrienne",
    "practitioner": {
      "id": "5dcb47800000000000000000",
      "name": "Jane Doe"
    },
    "recurrence_end": "2021-05-10",
    "recurrence_start": "2021-04-10",
    "room": {
      "id": "5dcb47800000000000000000"
    },
    "start_time": "16:00",
    "start_times": [
      {
        "value": "16:00"
      }
    ],
    "weekdays": [
      "monday"
    ]
  }
}

Changes