Update Booking

This endpoint is for updating a booking.

Request

bookingId

required

string

Id of the booking in Tyro Connect that should be updated

Authorization required	string Default: Bearer {$$.env.access_token}
Accept required	string (acceptHeaderBooking1_0) Default: application/vnd.tyro.connect+json;version=0.1 Specifies which version of the API to use. If no value is provided then 0.1 version will be used Enum: "application/vnd.tyro.connect+json;version=1.0" "application/vnd.tyro.connect+json;version=0.1"
Content-Type required	string Value: "application/json"

	object (assetUpdate)
bookingStatus	string (bookingStatus) The current status of the booking Enum: "CREATED" "ACCEPTED" "CANCELLED_BY_CUSTOMER" "CANCELLED_BY_MERCHANT" "REJECTED"
numberOfPeople	number (numberOfPeople) >= 1 The number of expected guests
	Array of objects (payments) A list of payments applied to the booking.
reason	string (reason) <= 50 characters The reason the booking was rejected or cancelled. Provided only when bookingStatus is `REJECTED`, `CANCELLED_BY_MERCHANT` or `CANCELLED_BY_CUSTOMER`
	object (customer) The customer making the booking
notes	string [ 1 .. 500 ] characters Notes specific to the booking. Example: 'Window seat please'
startTime	string <date-time> (time) The format of the date time is the notation as defined by RFC 3339, section 5.6
endTime	string <date-time> (time) The format of the date time is the notation as defined by RFC 3339, section 5.6
	object (origin) Information relevant to the booking partner that this booking was created with

Responses

204

No body content

400

When the provided request is not valid.

403

When you don't have the right permissions to update the booking.

404

When the provided bookingId does not match a booking stored in the system.

patch/bookings/{bookingId}

Request samples

application/merge-patch+json

{"bookingStatus": "CANCELLED_BY_CUSTOMER",
"reason": "Illness"
}

Response samples

application/vnd.tyro.connect+json;version=1.0

{"error": "\"asset.tableStatus\" must be one of [SEATED, DINING, FINALISED, CLOSING]"
}