Update a restaurant reservation

PATCH

/api/v1/partnership/restaurants/{restaurant_pk}/reservations/{id}/

const url = 'https://public.api.barestho.com/api/v1/partnership/restaurants/example/reservations/example/';
const options = {method: 'PATCH', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://public.api.barestho.com/api/v1/partnership/restaurants/example/reservations/example/ \
  --header 'Authorization: Basic <credentials>'

Partially updates a reservation. Only the fields included in the request body are modified; all other fields retain their current values.

Authorizations

basicAuth

Parameters

Path Parameters

required

string

The unique identifier of the reservation to update.

restaurant_pk

required

string

The unique identifier of the restaurant that owns the reservation.

Responses

200

The updated reservation object.

application/json

Partial representation of a reservation used for PATCH requests. All fields are optional; only the fields present in the request body will be updated. Refer to PartnerRestaurantReservation for full field semantics.

object

Unique numeric identifier for the reservation. Read-only.

integer

first_name

Updated first name of the guest.

string

nullable <= 255 characters

last_name

Updated last name of the guest.

string

nullable <= 255 characters

email

Updated email address of the guest.

string format: email

nullable <= 254 characters

phone

Updated phone number of the guest.

string

nullable <= 128 characters

start_time

Updated reservation start time (ISO 8601). Changes may affect availability.

string format: date-time

duration

Reservation duration. Recalculated by the server if start_time changes.

string

adults

Updated adult guest count. Must be between 1 and 50.

integer

>= 1 <= 50

children

Updated child guest count. Must be between 0 and 50.

integer

<= 50

comment

Updated guest or partner comment. Set to null to clear.

string

nullable

cancelled

Set to true to cancel the reservation. Triggers cancelled_at automatically.

boolean

cancelled_at

Cancellation timestamp. Managed by the server.

string format: date-time

nullable

confirmed

Set to true to confirm the reservation (asynchronous flow).

boolean

confirmed_at

Confirmation timestamp. Managed by the server.

string format: date-time

nullable

confirmation_mode

Updated confirmation mode. Refer to PartnerRestaurantReservation.confirmation_mode.

string

Allowed values: CONFIRMATION_MODE_SYNCHRONOUS CONFIRMATION_MODE_ASYNCHRONOUS

arrived

Set to true to mark the guest as arrived. Triggers arrived_at automatically.

boolean

arrived_at

Arrival timestamp. Managed by the server.

string format: date-time

nullable

no_show

Set to true to record a no-show. Triggers no_show_at automatically.

boolean

no_show_at

No-show timestamp. Managed by the server.

string format: date-time

nullable

language

Updated BCP 47 language tag for the guest.

string

metadata

Updated arbitrary metadata object. Replaces the existing metadata entirely when provided.

object

key

additional properties

Example

{
  "confirmation_mode": "CONFIRMATION_MODE_SYNCHRONOUS"
}

404

Not found.