Skip to content

Change an appointment

patch/api/v1/appointments/{id}

A new time (or, for a table, a new party size) goes through the same change function as the guest's own change on their manage link: the venue's allocator, layouts, locks, hours and every other booking, leaving this booking out of its own way, then the deposit for the new time and party size; the booking window binds a new time. A change never takes money: one that would owe a deposit or a card the booking does not hold (a new time's service-period deposit, or a bigger party crossing the venue's deposit or card rule) is a 409 payment_required. A party size change on a booking that already holds a deposit or a card is refused outright, for the venue to settle. The guest is told about a new time with the venue's usual change notice. Only a confirmed or pending booking that has not started can change. Send only the fields you are changing. The service and team member stay as booked.

Authorization

bearerApiKey appointments:write
AuthorizationBearer <token>

Build with a test key (sk_test_...): it works only in your API sandbox and never emails or texts anyone. Scopes, errors and limits.

In: header

Scope: appointments:write

Path Parameters

id*string

Appointment id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/appointments/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {}}