Edit appointment details
update_appointment_detailsEdit an appointment's carrier, driver, and reference fields (company, contact, driver, trailer, PO, notes), in any status. Omitted or empty string fields are left unchanged; those fields can't be cleared. poNumbers, when sent, replaces the whole PO list (send [] to clear it) and wins over poReference. Doesn't change time, door, or status: use reschedule_appointment to move it and the status tools to approve, cancel, or complete it. Doesn't email the carrier; fires an appointment.updated webhook. Returns the updated appointment. Requires scope appointments:write (Scheduler role or above).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | Notes from the carrier or scheduler, visible to staff. | |
| poNumbers | No | Replaces every PO on the appointment. Send [] to clear them. Omit to leave the list alone. Wins over poReference when both are sent. | |
| driverName | No | Driver's name. | |
| companyName | No | Carrier company name. | |
| contactName | No | Carrier contact person's name. | |
| driverNotes | No | Instructions for the driver. | |
| driverPhone | No | Driver's mobile; check-in texts go here when SMS check-in is on. | |
| poReference | No | One purchase order. Kept for older clients. Prefer poNumbers when the load has more than one. If both are sent, poNumbers wins. Sending only this replaces the list with this single value. | |
| contactEmail | No | Carrier contact email; confirmations and changes are emailed here. | |
| contactPhone | No | Carrier contact phone, e.g. +1 214 555 0100. | |
| appointmentId | Yes | Appointment id, from list_appointments, get_appointment, or create_appointment. | |
| trailerNumber | No | Trailer number. |