Sign in
Bookings

Confirm a booking

Confirms or cancels the specified pending booking. Nylas also updates the associated event on the provider.

Nylas validates the provided session ID and uses it to retrieve the related Configuration object. If you created a public Configuration, you don't need to include the Authorization request header with a session ID, but you do need to pass the Configuration object ID as a query parameter.

When you make a PUT request, Nylas replaces all data in the nested object with the information included in your request. For more information, see Updating objects.

put/v3/scheduling/bookings/{booking_id}

Request body

saltstring required

The salt extracted from the booking reference embedded in the organizer confirmation link, encoded as a URL-safe base64 string (without padding).

status'confirmed' | 'cancelled' required

The action to take on the pending booking.

cancellation_reasonstring

The reason that the booking is being cancelled.

Response

Booking confirmed or cancelled

OR

Example response

{
  "request_id": "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90",
  "data": {
    "booking_id": "xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx",
    "description": "Come ready to talk philosophy!",
    "event_id": "5d3qmne77v32r8l4phyuksl2x",
    "organizer": {
      "email": "leyah@example.com",
      "name": "Leyah Miller"
    },
    "status": "booked",
    "title": "Annual Philosophy Club Meeting"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.