Sign in
PractitionerRotas

Create a rota for a practitioner

Creates a new PractitionerRota for the given practitioner.

post/shop/practitioners/{practitionerId}/rotas

Request body

practitioner_idstring object-id required

Identifier of the practitioner this rota applies to. Must match the practitionerId in the URL; included in the body so the rota is self-describing on writeback to integrations and audit logs.

start_datestring date nullable

The date from which this rota is active (YYYY-MM-DD).

end_datestring date nullable

The date on which this rota ends. Omit or pass null for an open-ended rota.

scheduling_week_intervalinteger required

The number of weeks in the rolling schedule cycle.

Example request

{
  "scheduling_week_interval": 2,
  "availability_rules": [
    {
      "week_num": 1,
      "weekday": "monday",
      "time_from": "09:00",
      "time_to": "17:00",
      "offerings": [
        {
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ]
    }
  ]
}

Response

A single PractitionerRota object.

Example response

{
  "data": {
    "scheduling_week_interval": 2,
    "availability_rules": [
      {
        "week_num": 1,
        "weekday": "monday",
        "time_from": "09:00",
        "time_to": "17:00",
        "offerings": [
          {
            "offering_name": "Twilight massage",
            "offering_type": "appointment"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.