NYnylas
Bookings

Book an event

Changed on

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

  • Base URL
    https://api.us.nylas.com
  • Auth
    HTTP bearer

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.

event_idstring

(Group Configurations only, required) The ID of the existing group event the guest is joining. Use the event_id from the time slot returned by Get availability. Without it, the request returns Event not found.

For a recurring group event, this is the ID of the occurrence being booked, not the ID of the recurring series. Pass the series ID in master_id.

master_idstring

(Group Configurations only, required for recurring group events) The ID of the recurring series that the occurrence in event_id belongs to. Use the master_id from the same time slot as event_id. Omit it for non-recurring group events.

calendar_idstring

(Group Configurations only, required) The ID of the calendar that holds the group event. Use the calendar_id from the same time slot as event_id.

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

{
  "event_id": "7v3k9m2qp1abc4defg5hij6klm",
  "master_id": "4p8r2t6v0xbcd1fgh3jkl5mno7",
  "calendar_id": "host@example.com",
  "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