UNuntetherlabs

Update Appointment

patch/v1/appointments/{appointmentId}

Request

  • Base URL
    https://app.untetherlabs.com/api
  • URL
    https://app.untetherlabs.com/api/v1/appointments/{appointmentId}
  • Auth
    HTTP bearer

Path parameters

appointmentIdstring uuid required

Request body

createdAtstring
typestring

Appointment type, company specific

status'upcoming' | 'occurred' | 'cancelled' | 'no-show' | 're-scheduled'
providerIdstring uuid
memberIdstring uuid nullable
startDatestring
endDatestring
actualStartDatestring nullable
actualEndDatestring nullable
locationstring nullable
cancellationDatestring nullable

Only present when status = cancelled

cancellationReasonstring nullable

Only present when status = cancelled

versioninteger

Object version to change, will return a version conflict error if out of date

Example request

{
  "createdAt": "2024-11-20T07:43:34+0000",
  "type": "video",
  "startDate": "2024-11-20T07:43:34+0000",
  "endDate": "2024-11-20T07:43:34+0000",
  "actualStartDate": "2024-11-20T07:43:34+0000",
  "actualEndDate": "2024-11-20T07:43:34+0000",
  "cancellationDate": "2024-11-20T07:43:34+0000"
}

Response

idstring uuid required
createdAtstring required
typestring required

Appointment type, company specific

status'upcoming' | 'occurred' | 'cancelled' | 'no-show' | 're-scheduled' required
providerIdstring uuid required
memberIdstring nullable required
startDatestring required
endDatestring required
actualStartDatestring nullable required
actualEndDatestring nullable required
locationstring nullable required
cancellationDatestring nullable required

Only present when status = cancelled

cancellationReasonstring nullable required

Only present when status = cancelled

Example response

{
  "createdAt": "2024-11-20T07:43:34+0000",
  "type": "video",
  "startDate": "2024-11-20T07:43:34+0000",
  "endDate": "2024-11-20T07:43:34+0000",
  "actualStartDate": "2024-11-20T07:43:34+0000",
  "actualEndDate": "2024-11-20T07:43:34+0000",
  "cancellationDate": "2024-11-20T07:43:34+0000"
}

Changes

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