Partner API
Update appointment
PATCH /api/v2/appointments/:appointment_uuid - Partial update of an appointment. Send at least one recognized field.
PATCH
/api/v2/appointments/:appointment_uuidPartial update of an appointment. Send at least one recognized field.
Required scope: appointments (or *).
Path parameters
| Name | Required | Description |
|---|---|---|
appointment_uuid | Yes | Appointment UUID |
JSON body
| Name | Required | Description |
|---|---|---|
title | No | Appointment title |
notes | No | Appointment notes |
status | No | Status (e.g. scheduled, completed, cancelled) |
start_time | No | Start datetime (YYYY-MM-DD HH:MM:SS) |
end_time | No | End datetime (YYYY-MM-DD HH:MM:SS) |
agent_uuid | No | Reassign to another agent |
curl -s -X PATCH -H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "Benefit consultation (reschedule)",
"notes": "Moved to afternoon slot",
"status": "scheduled",
"start_time": "2026-07-22 15:00:00",
"end_time": "2026-07-22 15:30:00",
"agent_uuid": "c0a80101-0000-4000-8000-000000000003"
}' \
"https://benefitpath.com/api/v2/appointments/c0a80101-0000-4000-8000-000000000002"{
"success": true,
"appointment": {
"appointment_uuid": "c0a80101-0000-4000-8000-000000000002",
"title": "Benefit consultation (reschedule)",
"notes": "Moved to afternoon slot",
"start_time": "2026-07-22 15:00:00",
"end_time": "2026-07-22 15:30:00",
"status": "scheduled",
"agent_uuid": "c0a80101-0000-4000-8000-000000000003"
}
}See Errors for the standard error envelope and rate limits.