Update an appointment
Partial update. isOnline / isHybrid may be recomputed from rooms and addresses. Omit array fields to leave them unchanged; empty arrays for organizers/participants/groups are rejected.
PATCH
/appointments/{id}Path parameters
idstringrequiredAppointment ID
Request body
requiredapplication/jsontitlestringmin length 1 · max length 255
dateTimestring<date-time>durationintegerDuration in minutes
min 1
isOnlinebooleanMay be adjusted server-side from rooms, address, and onlineAddress.
isHybridbooleanMay be adjusted server-side from rooms, address, and onlineAddress.
addressstringonlineAddressstringlocationstringroomsAppointmentRoomInput[]Replaces room bookings when provided. v4 only — legacy `roomId` / `roomIds` are not accepted.
Show propertiesHide properties
Array of
AppointmentRoomInputroomIdstringrequiredInstitution room ID from Room Management.
setupIdstring | nullOptional room setup/version ID. Omit or pass null for the default setup.
courseIdsstring[]Layer IDs (`layerId` from `GET /courses`).
min items 1
organizerIdsstring[]min items 1
userIdsstring[]min items 1
userGroupIdsstring[]min items 1
appointmentTypeIdstring | nullnotesstringResponses
200Updated appointment
dataAppointmentrequiredFull appointment from `GET /appointments`, `GET /appointments/{id}`, and create responses. Includes participants, creator, groups, and series when loaded.
Show propertiesHide properties
idstringrequiredtitlestringrequirednotesstringdateTimestring<date-time>requireddurationintegerrequiredDuration in minutes
isOnlinebooleanrequiredisHybridbooleanrequiredonlineAddressstringaddressstringlocationstring | nullproviderstringroomIdstring | nullDeprecated — use appointmentRooms.
appointmentRoomsAppointmentRoomBooking[]Show propertiesHide properties
Array of
AppointmentRoomBookingroomIdstringsetupIdstring | nullroomobjectsetupobject | nullappointmentLayersAppointmentLayer[]Show propertiesHide properties
Array of
AppointmentLayerlayerIdstringlayerobject | nullShow propertiesHide properties
idstringnamestringcourseobject | nullShow propertiesHide properties
idstringCourse entity ID
codestring | nullnamestringorganizerUsersAppointmentOrganizer[]Show propertiesHide properties
Array of
AppointmentOrganizerorganizerIdstringrequiredappointmentUsersAppointmentUserParticipant[]Show propertiesHide properties
Array of
AppointmentUserParticipantuserIdstringuserAppointmentSafeUserShow propertiesHide properties
idstringnamestringemailstringfirstNamestring | nulllastNamestring | nullimagestring | nullappointmentCreatorobject[]Institution admin/moderator used as creator for API-created appointments.
Show propertiesHide properties
Array of
objectuserIdstringuserAppointmentSafeUserShow propertiesHide properties
idstringnamestringemailstringfirstNamestring | nulllastNamestring | nullimagestring | nullappointmentUserGroupsobject[]Show propertiesHide properties
Array of
objectuserGroupIdstringuserGroupobjectappointmentTypeobject | nullseriesobject | nullmetaResponseMetarequiredShow propertiesHide properties
requestIdstringrequiredtimestampstring<date-time>requiredversionstringrequiredAllowed:
v4400Bad Request
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring401Unauthorized
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring403Forbidden
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring404Not Found
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring429Too Many Requests
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring500Internal Server Error
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestringRequest
curl -X PATCH "https://fuxam.app/api/v4/appointments/string" \
-H "Content-Type: application/json" \
-d '{
"title": "Introduction lecture (rescheduled)",
"dateTime": "2026-09-16T10:00:00.000Z",
"duration": 90
}'const response = await fetch("https://fuxam.app/api/v4/appointments/string", {
method: "PATCH",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"title": "Introduction lecture (rescheduled)",
"dateTime": "2026-09-16T10:00:00.000Z",
"duration": 90
})
});import requests
response = requests.patch(
"https://fuxam.app/api/v4/appointments/string",
headers={
"Content-Type": "application/json"
},
json={
"title": "Introduction lecture (rescheduled)",
"dateTime": "2026-09-16T10:00:00.000Z",
"duration": 90
},
)Response
{
"data": {
"id": "appt_def456",
"title": "Introduction lecture",
"notes": "First session of the semester",
"dateTime": "2026-09-15T10:00:00.000Z",
"duration": 90,
"isOnline": false,
"isHybrid": false,
"onlineAddress": "",
"address": "Building A, Room 101",
"location": null,
"provider": "fuxam",
"roomId": null,
"appointmentLayers": [
{
"layerId": "layer_abc123",
"layer": {
"id": "layer_abc123",
"name": "CS101"
},
"course": {
"id": "clx1234567890",
"code": "CS101",
"name": "Introduction to Computer Science"
}
}
],
"appointmentRooms": [],
"organizerUsers": [
{
"organizerId": "user_organizer1"
}
],
"appointmentUsers": [
{
"userId": "user_student1",
"user": {
"id": "user_student1",
"name": "Jane Doe",
"email": "jane@example.com",
"firstName": "Jane",
"lastName": "Doe",
"image": null
}
}
],
"appointmentCreator": [
{
"userId": "user_admin1",
"user": {
"id": "user_admin1",
"name": "Admin User",
"email": "admin@example.com",
"firstName": "Admin",
"lastName": "User",
"image": null
}
}
],
"appointmentUserGroups": [],
"appointmentType": null,
"series": null
},
"meta": {
"requestId": "req_1234567890_abc",
"timestamp": "2026-06-02T07:00:00.000Z",
"version": "v4"
}
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}