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:

FieldTypeRequiredDescription
statusstringNopending, confirmed, cancelled, completed or no_show. Confirming or cancelling also creates or removes the booking's events in connected calendars.
start_datetimestring (date-time)NoNew 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_idintegerNoChange the service; end_datetime is recalculated.
party_sizeintegerNoNumber of people.
duration_minutesintegerNoNew length for services with duration_mode: "flexible" (one of duration_options).
cancelled_atstring (date-time)NoSend with status: "cancelled"; it is not set automatically.
cancelled_bystringNocustomer, organization or system.
cancellation_reasonstringNoFree text.
customer_notes, internal_notesstring | nullNoNotes.
payment_statusstringNonone, pending, paid or refunded.
payment_amountnumber | nullNoAmount, minimum 0.
preferred_resource_idinteger | nullNoPreferred resource.
contact_id, deal_id, company_id, conversation_id, estimate_id, invoice_idinteger | nullNoRelated records.
google_meet_linkstring | nullNoVideo-call link used in emails.
custom_fields_by_keyobjectNoMerged 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 status to completed awards loyalty points or stamps to the contact (once per reservation) when the organization has an active loyalty program; payment_amount counts as the purchase amount.

Errors

StatusWhen
400 Bad RequestInvalid field value or enum, or unknown custom field key.
404 Not FoundNo reservation with that ID in your organization.

Report an issue with this documentation

Please log in to report issues with our documentation.