Create Recurring Appointments

Request

Creates a recurring appointment series for a client based on an event schedule. Automatically generates future appointments according to the schedule pattern.

Security

BearerPartnerUser

Path

location_idnumberrequired

ID of a location.

Example:123

schedule_idintegerrequired

ID of a schedule.

Example:123

Acceptstringrequired

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

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

Example:application/vnd.api.v2+json

Content-Typestringrequired

Should be equal to application/json

Example:application/json

Bodyapplication/json

client_idnumberrequired

ID of client for creating a client schedule.

Example:123

schedule_days_idsArray of numbers, [ 1 .. 7 ] itemsrequired

IDs of schedule series, min of 1 series, max of 7 series.

Example:

[
  123
]

comer_idnumber

ID of client`s comer for creating a client schedule.

Example:123

curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/123/schedules/123/client_schedules \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": 123,
    "comer_id": 123,
    "schedule_days_ids": [
      123
    ]
  }'

Responses

Created

Bodyapplication/json

successboolean(Successful response status)

Response status.

Example:true

dataobject(Object of model "Client schedule")

Data for an existing client schedule in a location.

Example:

{
  "id": 123,
  "loyalty_abonement_id": null,
  "final_day": "2022-01-01 12:12:12",
  "days": [
    { … }
  ]
}

metaArray of any or object(Empty meta object)

Additional response data (empty object or empty array)

Example:

{}

Response

{
  "success": true,
  "data": {
    "id": 123,
    "loyalty_abonement_id": null,
    "final_day": "2022-01-01 12:12:12",
    "days": [ … ]
  },
  "meta": {}
}