Sign in
Bookings

Book an event

Books an event with the participants listed in the session's Configuration object, using the details from the Configuration. The start_time and end_time must correspond to a valid time slot returned by the Scheduling Availability endpoint using the same Configuration.

Nylas validates the 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.

post/v3/scheduling/bookings

Request body

start_timeinteger required

The event's start time, in seconds using the Unix timestamp format.

end_timeinteger required

The event's end time, in seconds using the Unix timestamp format.

timezonestring

The guest's timezone, used in email notifications. If not provided, Nylas uses the timezone from the Configuration object.

email_language'en' | 'fr' | 'de' | 'es' | 'nl' | 'sv' | 'ja' | 'zh'

The language of the guest email notifications.

additional_fieldsobject

A dictionary of additional field keys mapped to the values populated by the guest in the booking form.

Example request

{
  "additional_fields": {
    "name": "Dorothy Vaughan",
    "email_address": "dorothy@example.com"
  }
}

Response

Create a new booking

request_idstring

The request ID.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88"
}

Changes

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