Delete Timetable Appointment

Request

Delete one Appointment from the timetable by its appointmentId.

If the deleted Appointment belongs to a linked visit, the response returns the remaining related Appointments as a JSON:API collection. Deleting an Appointment without related Appointments returns an empty data array.

Security

BearerPartnerUser

Path

location_idintegerrequired

Location ID

Query

includeArray of strings, unique(Appointment Includes)

Related resources to include in returned Appointments

Items Enum:"client""client.custom_field_values""staff""services""goods""resource_instances""labels""attendance_service_items""attendance_good_items""attendance_document"

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

Request media type

Value:"application/json"

Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired

appointmentIdinteger, >= 1required

Appointment ID

curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/locations/{location_id}/timetable/appointments/delete?include=client' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appointmentId": 12345
  }'

Responses

Appointment deleted; remaining related Appointments returned

Bodyapplication/json

dataArray of objects(Appointment Resource)required

includedArray of objects(includedResource)

Resources requested through include, when available

Response

{
  "data": []
}