Update a reservation
Partially updates a reservation: reschedule, change status (confirm, complete, cancel, no-show), notes, links or custom fields. Only the fields you send change.
Endpoint
PATCH/reservations/:id
Body
Any writable field of the reservation object. Common ones:
| Field | Type | Required | Description |
|---|---|---|---|
status | string | No | pending, confirmed, cancelled, completed or no_show. Confirming or cancelling also creates or removes the booking's events in connected calendars. |
start_datetime | string (date-time) | No | New start. Availability is checked again (the reservation itself is excluded) and the request fails with 400 when the new time is taken. end_datetime is recalculated from the service duration, and reminders_sent is reset so reminders go out again. |
service_id | integer | No | Change the service; end_datetime is recalculated. |
party_size | integer | No | Number of people. |
duration_minutes | integer | No | New length for services with duration_mode: "flexible" (one of duration_options). |
cancelled_at | string (date-time) | No | Send with status: "cancelled"; it is not set automatically. |
cancelled_by | string | No | customer, organization or system. |
cancellation_reason | string | No | Free text. |
customer_notes, internal_notes | string | null | No | Notes. |
payment_status | string | No | none, pending, paid or refunded. |
payment_amount | number | null | No | Amount, minimum 0. |
preferred_resource_id | integer | null | No | Preferred resource. |
contact_id, deal_id, company_id, conversation_id, estimate_id, invoice_id | integer | null | No | Related records. |
google_meet_link | string | null | No | Video-call link used in emails. |
custom_fields_by_key | object | No | Merged into existing values; send a key with null to clear it. |
Updating does not re-run the slot and capacity checks done on create, and does not reassign resources.
Request
Reschedule:
Cancel:
Mark as completed:
Response
Returns the updated reservation object, with service, contact and assigned_resources.
json
Side effects
- Runs the organization's Reservation updated automations.
- Changing
statustocompletedawards loyalty points or stamps to the contact (once per reservation) when the organization has an active loyalty program;payment_amountcounts as the purchase amount.
Errors
| Status | When |
|---|---|
400 Bad Request | Invalid field value or enum, or unknown custom field key. |
404 Not Found | No reservation with that ID in your organization. |
Report an issue with this documentation
Please log in to report issues with our documentation.