TypeScript

openemail.bookings

Every method in this namespace: its signature, its parameters, what it returns and an example.

Methods

Public links where somebody books a meeting on a person's calendar: create a booking page, change its hours, questions and rules, pause or delete it, read the times it offers, list the meetings guests booked, and approve, decline or cancel one. An API key acts for the workspace owner, and an app for the person who connected it.

`bookings.listPages()`

List the booking pages of the person

calendar:read

Signature

listPages(options?: RequestScope): Promise<Array<BookingPageResource>>

Resolves every booking page of the person, oldest first. A booking page is a public link, /book/<slug>, where somebody picks a free time and books a meeting on the calendar of that person. Each page comes with its settings in config, the link to hand to guests in url, and in counts how many of its bookings are upcoming and how many wait for approval.

status is active while the page takes bookings and paused while its link works but offers no times. problem says what stops a page from taking bookings and is null when nothing does. away lists the out of office periods that close the page. A person holds at most 25 pages, so the list comes whole and is never paged.

Parameters

options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Returns

Array<BookingPageResource>. Each item has id, slug, name, status, url, problem, config, counts, away, createdAt and updatedAt.

Example

const pages = await openemail.bookings.listPages() for (const page of pages) {    console.log(page.name, page.url, page.status, page.counts.upcoming, page.counts.pending)}

Notes

A booking page belongs to one person. An API key acts as the workspace owner and reaches the pages of the owner, and a connected app reaches the pages of the person who connected it.
problem is sender when config.fromEmail can no longer send, hours when no hours are open at all, and host when the person left the workspace.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.

Also available in

API: GET /booking-pages
Python: bookings.list_pages()
Ruby: bookings.list_pages
PHP: bookings->listPages
Go: Bookings.ListPages
Java: bookings().listPages
C#: Bookings.ListPagesAsync
CLI: openemail bookings list-pages

`bookings.getPage()`

Read one booking page by id

calendar:read

Signature

getPage(id: string, options?: RequestScope): Promise<BookingPageResource>

Looks up a single booking page and returns it in the same shape as a row of listPages, with every setting in config: the meeting lengths, where the meeting happens, the weekly hours and the dates with their own hours, the notice, the buffers and the daily limit, whether a booking waits for approval, the address its emails come from, the questions a guest is asked, how the page looks and what a guest may change afterwards.

config.availability.weekly holds seven lists, Sunday first, of the hours open on that weekday, each as minutes after midnight in config.availability.timezone. problem says what stops the page from taking bookings, and away lists the out of office periods of config.fromEmail that are running or still to come. While config.busy.outOfOffice is true the page offers no times inside them.

Parameters

idstringRequired: Booking page id such as bkp_5c1e9a7b3d2f48e6a0b4c7d1, as listPages returns it.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Returns

BookingPageResource with id, slug, name, status, url, problem, config, counts, away, createdAt and updatedAt.

Example

const page = await openemail.bookings.getPage('bkp_5c1e9a7b3d2f48e6a0b4c7d1') console.log(page.url, page.config.durations, page.config.availability.timezone, page.problem)

Notes

A missing page throws OpenEmailApiError with isNotFound true and code booking_page_not_found. A page that belongs to somebody else in the workspace is missing too.
A booking page belongs to one person. An API key acts as the workspace owner and reaches the pages of the owner, and a connected app reaches the pages of the person who connected it.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.

Also available in

API: GET /booking-pages/{id}
Python: bookings.get_page()
Ruby: bookings.get_page
PHP: bookings->getPage
Go: Bookings.GetPage
Java: bookings().getPage
C#: Bookings.GetPageAsync
CLI: openemail bookings get-page

`bookings.createPage()`

Create a booking page

calendar:writeemails:send

Signature

createPage(body: BookingPageCreate, options?: RequestScope): Promise<BookingPageResource>

Creates a booking page and resolves with it as it is stored. The page takes bookings at once, at the link in url. Only name is required: the page starts with weekdays from 09:00 to 17:00, 30 minute meetings, four hours of notice, times up to 60 days ahead and the first address the person may send from. Anything in config replaces that default, and what it leaves out keeps it.

slug is the last part of the public link, /book/<slug>. Left out, it is made from the name. timezone says which time zone the working hours are read in when config.availability.timezone is not sent.

The times a page offers are its working hours with everything taken out that makes the person busy: their calendar events, invitations they have not declined, calendars they subscribed to, bookings they already have, the gaps the page keeps around meetings, and the days they are out of office. A booking is a calendar event organised by config.fromEmail, and the guest is told by email from that address, so the call needs emails:send beside calendar:write.

Parameters

body.namestringRequired: What the page is called, shown to guests as its heading, such as Intro call. Trimmed, 1 to 80 characters.
body.slugstring: The last part of the public link: 3 to 60 lowercase letters and digits, with single hyphens between words. It is unique across OpenEmail. Left out, it is made from the name.
body.timezonestring: The IANA time zone the working hours are read in, such as Europe/Berlin, when config.availability.timezone is not sent. Defaults to UTC.
body.config.descriptionstring: Text shown under the name of the page, up to 2,000 characters. Basic Markdown works: bold, italic, links and lists. Defaults to none.
body.config.hostNamestring: The name guests see as the person they meet, up to 80 characters. Defaults to the name of the account.
body.config.durationsArray<number>: The meeting lengths a guest can pick, in minutes: 1 to 4 of them, each a multiple of 5 between 5 and 720. Defaults to [30].
body.config.location.kindBookingLocationKind: Where the meeting happens: video with a fixed link in value, phone, where the guest is asked for a number, in-person with the address in value, or none. Defaults to none.
body.config.location.valuestring: The https:// link of a video meeting or the address of an in-person one, up to 500 characters. It is dropped for phone and none.
body.config.availability.timezonestring: The IANA time zone the hours of the page are read in. Defaults to timezone.
body.config.availability.weeklyArray<Array<BookingTimeRange>>: Seven lists, Sunday first, of the hours open on that weekday. Each range is { start, end } in minutes after midnight, so { start: 540, end: 1020 } is 09:00 to 17:00. An empty list closes the day, and a day takes at most 6 ranges. Defaults to 09:00 to 17:00 from Monday to Friday.
body.config.availability.overridesArray<BookingDateOverride>: Dates with their own hours, at most 180, each { date, ranges }. date is YYYY-MM-DD in the time zone of the page, and an empty ranges closes that date. Defaults to none.
body.config.rules.noticeMinutesnumber: How many minutes ahead a booking has to be made, from 0 to 43,200. Defaults to 240.
body.config.rules.horizonDaysnumber: How many days ahead the page offers times, from 1 to 365. Defaults to 60.
body.config.rules.intervalMinutesnumber | null: Minutes between two start times: 5, 10, 15, 20, 30, 45, 60, 90 or 120. Null, the default, steps by the length of the meeting.
body.config.rules.bufferBeforeMinutesnumber: Minutes kept free before every meeting, from 0 to 240. Defaults to 0.
body.config.rules.bufferAfterMinutesnumber: Minutes kept free after every meeting, from 0 to 240. Defaults to 0.
body.config.rules.dailyLimitnumber | null: The most bookings the page takes on one day, from 1 to 50. Null, the default, sets no limit.
body.config.approvalboolean: True holds each new booking as a request until approve or decline answers it. False, the default, confirms it at once.
body.config.fromEmailstring: The address the booking emails are sent from and the calendar events are organised by. It has to be one the owner of the page may send from. Defaults to the first such address.
body.config.notifyHostboolean: Whether fromEmail gets an email about each new, moved or cancelled booking. Defaults to true.
body.config.questionsArray<BookingQuestion>: What the guest is asked besides their name and email, at most 10, each { id, kind, label, required, options }. id is a stable key for the answers: 4 to 16 lowercase letters and digits, unique on the page. kind is text, long-text, phone, choice or checkbox. options holds the answers of a choice question, from 2 to 12, and is empty for the other kinds. Defaults to none.
body.config.confirmationstring: Text shown to the guest after booking and added to the confirmation email, up to 1,000 characters. Defaults to none.
body.config.redirectUrlstring: An https:// page to send the guest to after booking, or an empty string for none, which is the default.
body.config.appearance.accentstring: The colour of buttons and the picked day, as #rrggbb. Defaults to #18181b.
body.config.appearance.themeBookingTheme: auto follows the device of the guest, and light or dark forces one. Defaults to auto.
body.config.appearance.showAvatarboolean: Whether the page shows the photo of the person, or their initials when they have none. Defaults to true.
body.config.guestChanges.cancelboolean: Whether a guest may cancel from the link in their emails. Defaults to true.
body.config.guestChanges.rescheduleboolean: Whether a guest may move the meeting from the link in their emails. Defaults to true.
body.config.guestChanges.cutoffMinutesnumber: How many minutes before the meeting those changes close, from 0 to 20,160. Defaults to 0.
body.config.busy.addressesArray<string> | null: The addresses whose invitations block time unless declined, at most 50. Null, the default, checks every address the person holds.
body.config.busy.subscriptionsboolean: Whether events from calendars the person subscribed to block time. Defaults to true.
body.config.busy.outOfOfficeboolean: Whether the page offers no times while fromEmail is out of office. Defaults to true.
body.config.seo.titlestring: The title of the browser tab and of a search result, up to 120 characters. Empty, the default, uses the name of the page and the host.
body.config.seo.descriptionstring: The summary under the title in a search result, up to 300 characters. Empty, the default, uses the start of the description.
body.config.seo.indexableboolean: Whether search engines may list the page. Defaults to false, which asks them not to.
body.config.extraGuestsnumber: How many other people a guest may add to a booking, 0 to 10. Each one gets the invitation and every later change. Defaults to 0, which hides the field.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Returns

BookingPageResource with the new id, status active, the slug and url of its link, and config with every default filled in.

Example

const page = await openemail.bookings.createPage({    name: 'Intro call',    timezone: 'Europe/Berlin',    config: {        description: 'A first conversation about your project.',        durations: [30, 60],        location: { kind: 'video', value: 'https://meet.example.com/ada' },        rules: { bufferAfterMinutes: 15 },        approval: true    }}) console.log(page.id, page.url, page.config.fromEmail)

Notes

A booking page belongs to one person. An API key acts as the workspace owner and makes a page of the owner, and a connected app makes a page of the person who connected it.
A person holds at most 25 pages. One more is a 403 booking_page_limit_reached.
A slug another page already uses is a 409 booking_link_taken. A slug that is not a valid link, a fromEmail the person may not send from, a video location without a link, an in-person one without an address and two questions with the same id are 422 invalid_booking_page, with the reason in the message. A few slugs such as manage and admin are reserved.
A value of the wrong type or length, a range that ends before it starts and a time zone in config.availability that is not known are 422 invalid_parameter with param naming the field. A key beside name, slug, timezone and config is 422 unknown_parameter.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.
Not retried automatically. A slug made from the name gets a few random characters when the plain one is taken, so a retry after a lost response can leave two pages. List them and delete the spare.

Also available in

API: POST /booking-pages
Python: bookings.create_page()
Ruby: bookings.create_page
PHP: bookings->createPage
Go: Bookings.CreatePage
Java: bookings().createPage
C#: Bookings.CreatePageAsync
CLI: openemail bookings create-page

`bookings.updatePage()`

Change the name, the link, the status or any setting of a booking page

calendar:writeemails:send

Signature

updatePage(id: string, patch: BookingPagePatch, options?: RequestScope): Promise<BookingPageResource>

Changes a booking page and resolves with it as it is stored. Send only what changes: a field left out stays as it is, and a patch with nothing in it is a 422.

config is merged, not replaced. A top-level value such as approval or fromEmail replaces the stored one. Inside location, availability, rules, appearance, guestChanges, busy and seo each field is merged on its own, so rules: { dailyLimit: 4 } leaves the notice and the buffers alone. A list is replaced whole: send every entry of durations, questions, availability.weekly or availability.overrides again, not only the ones that change.

Set status to paused to stop offering times without losing the link, and to active to offer them again. Bookings already made keep their time whatever changes. A new slug moves the page to a new link and the old one stops working, so links already handed out break.

Parameters

idstringRequired: Booking page id such as bkp_5c1e9a7b3d2f48e6a0b4c7d1, as listPages returns it.
patch.namestring: New name, shown to guests as the heading of the page. Trimmed, 1 to 80 characters. Left out, the name stays.
patch.slugstring: New last part of the public link: 3 to 60 lowercase letters and digits, with single hyphens between words. It is unique across OpenEmail. Left out, the link stays.
patch.statusBookingPageStatus: active takes bookings. paused keeps the link working but offers no times. Left out, it stays.
patch.config.descriptionstring: Text shown under the name of the page, up to 2,000 characters. Basic Markdown works: bold, italic, links and lists. An empty string clears it.
patch.config.hostNamestring: The name guests see as the person they meet, up to 80 characters.
patch.config.durationsArray<number>: The meeting lengths a guest can pick, in minutes, replacing the list the page had: 1 to 4 of them, each a multiple of 5 between 5 and 720.
patch.config.location.kindBookingLocationKind: Where the meeting happens: video with a fixed link in value, phone, where the guest is asked for a number, in-person with the address in value, or none.
patch.config.location.valuestring: The https:// link of a video meeting or the address of an in-person one, up to 500 characters. It is dropped for phone and none.
patch.config.availability.timezonestring: The IANA time zone the hours of the page are read in, such as Europe/Berlin.
patch.config.availability.weeklyArray<Array<BookingTimeRange>>: All seven lists again, Sunday first, of the hours open on that weekday. Each range is { start, end } in minutes after midnight, so { start: 540, end: 1020 } is 09:00 to 17:00. An empty list closes the day, and a day takes at most 6 ranges.
patch.config.availability.overridesArray<BookingDateOverride>: Every date with its own hours again, at most 180, each { date, ranges }. date is YYYY-MM-DD in the time zone of the page, and an empty ranges closes that date. An empty array removes them all.
patch.config.rules.noticeMinutesnumber: How many minutes ahead a booking has to be made, from 0 to 43,200.
patch.config.rules.horizonDaysnumber: How many days ahead the page offers times, from 1 to 365.
patch.config.rules.intervalMinutesnumber | null: Minutes between two start times: 5, 10, 15, 20, 30, 45, 60, 90 or 120. Null steps by the length of the meeting.
patch.config.rules.bufferBeforeMinutesnumber: Minutes kept free before every meeting, from 0 to 240.
patch.config.rules.bufferAfterMinutesnumber: Minutes kept free after every meeting, from 0 to 240.
patch.config.rules.dailyLimitnumber | null: The most bookings the page takes on one day, from 1 to 50. Null sets no limit.
patch.config.approvalboolean: True holds each new booking as a request until approve or decline answers it. False confirms it at once. Requests already waiting keep waiting.
patch.config.fromEmailstring: The address the booking emails are sent from and the calendar events are organised by. It has to be one the owner of the page may send from.
patch.config.notifyHostboolean: Whether fromEmail gets an email about each new, moved or cancelled booking.
patch.config.questionsArray<BookingQuestion>: Every question again, at most 10, each { id, kind, label, required, options }. id is a stable key for the answers: 4 to 16 lowercase letters and digits, unique on the page. kind is text, long-text, phone, choice or checkbox. options holds the answers of a choice question, from 2 to 12, and is empty for the other kinds. An empty array asks nothing more.
patch.config.confirmationstring: Text shown to the guest after booking and added to the confirmation email, up to 1,000 characters. An empty string clears it.
patch.config.redirectUrlstring: An https:// page to send the guest to after booking, or an empty string for none.
patch.config.appearance.accentstring: The colour of buttons and the picked day, as #rrggbb.
patch.config.appearance.themeBookingTheme: auto follows the device of the guest, and light or dark forces one.
patch.config.appearance.showAvatarboolean: Whether the page shows the photo of the person, or their initials when they have none.
patch.config.guestChanges.cancelboolean: Whether a guest may cancel from the link in their emails.
patch.config.guestChanges.rescheduleboolean: Whether a guest may move the meeting from the link in their emails.
patch.config.guestChanges.cutoffMinutesnumber: How many minutes before the meeting those changes close, from 0 to 20,160.
patch.config.busy.addressesArray<string> | null: The addresses whose invitations block time unless declined, at most 50. Null checks every address the person holds.
patch.config.busy.subscriptionsboolean: Whether events from calendars the person subscribed to block time.
patch.config.busy.outOfOfficeboolean: Whether the page offers no times while fromEmail is out of office.
patch.config.seo.titlestring: The title of the browser tab and of a search result, up to 120 characters. An empty string goes back to the name of the page and the host.
patch.config.seo.descriptionstring: The summary under the title in a search result, up to 300 characters. An empty string goes back to the start of the description.
patch.config.seo.indexableboolean: Whether search engines may list the page.
patch.config.extraGuestsnumber: How many other people a guest may add to a booking, 0 to 10. Each one gets the invitation and every later change. 0 hides the field.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Returns

BookingPageResource with the unchanged id, and everything else as it is now.

Example

const page = await openemail.bookings.updatePage('bkp_5c1e9a7b3d2f48e6a0b4c7d1', {    config: {        durations: [45],        rules: { bufferAfterMinutes: 15, dailyLimit: 4 }    }}) console.log(page.config.durations, page.config.rules)

Notes

A missing page is a 404 booking_page_not_found, and so is a page that belongs to somebody else in the workspace.
A slug another page already uses is a 409 booking_link_taken. A slug that is not a valid link, a fromEmail the person may not send from, a video location without a link, an in-person one without an address and two questions with the same id are 422 invalid_booking_page, with the reason in the message.
An empty patch, a value of the wrong type or length, a range that ends before it starts and a time zone that is not known are 422 invalid_parameter. A key beside name, slug, status and config is 422 unknown_parameter.
A booking page belongs to one person. An API key acts as the workspace owner and reaches the pages of the owner, and a connected app reaches the pages of the person who connected it.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.
The SDK retries this call after a network failure, since the same patch sent twice leaves the same page.

Also available in

API: PATCH /booking-pages/{id}
Python: bookings.update_page()
Ruby: bookings.update_page
PHP: bookings->updatePage
Go: Bookings.UpdatePage
Java: bookings().updatePage
C#: Bookings.UpdatePageAsync
CLI: openemail bookings update-page

`bookings.deletePage()`

Delete a booking page

calendar:write

Signature

deletePage(id: string, options?: RequestScope): Promise<DeletedBookingPageResource>

Deletes a booking page for good. Its public link stops working and the list of its bookings goes with it, so list no longer shows them and guests can no longer move or cancel through the links in their emails. The meetings already booked stay on the calendar, where calendar.cancelEvent can still call one off.

There is no undo. To stop offering times and keep the page, its link and its bookings, use updatePage with status paused.

Parameters

idstringRequired: Booking page id such as bkp_5c1e9a7b3d2f48e6a0b4c7d1, as listPages returns it.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Returns

DeletedBookingPageResource, { object: 'booking_page', id, deleted: true }.

Example

const removed = await openemail.bookings.deletePage('bkp_5c1e9a7b3d2f48e6a0b4c7d1') console.log(removed.id, removed.deleted)

Notes

It sends no email, so it needs calendar:write alone. Guests are not told that the page is gone.
The SDK does not retry a delete. A 404 booking_page_not_found on your own second attempt after a lost response means the first one worked.
A booking page belongs to one person. An API key acts as the workspace owner and reaches the pages of the owner, and a connected app reaches the pages of the person who connected it.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.

Also available in

API: DELETE /booking-pages/{id}
Python: bookings.delete_page()
Ruby: bookings.delete_page
PHP: bookings->deletePage
Go: Bookings.DeletePage
Java: bookings().deletePage
C#: Bookings.DeletePageAsync
CLI: openemail bookings delete-page

`bookings.listTimes()`

List the times a booking page offers

calendar:read

Signature

listTimes(id: string, options?: BookingTimesOptions): Promise<BookingTimesResource>

Resolves the start times a guest could book on a page inside a window, in order. They are the hours of the page with everything taken out that makes the person busy: their calendar events, invitations they have not declined, calendars they subscribed to, bookings they already have, the gaps the page keeps around meetings, its daily limit, its notice and the out of office periods that close it.

The window starts at from, or now, and ends at to, or 14 days later. It covers at most 62 days, and a later to is cut back to that. durationMinutes picks which meeting length the times are for and has to be one of the durations of the page. Left out, the shortest is used. Both bounds take a Date or an ISO 8601 string, and the SDK converts a Date with toISOString().

A paused page still answers, so the times can be checked before it is turned on. A page with a problem offers nothing.

Parameters

idstringRequired: Booking page id such as bkp_5c1e9a7b3d2f48e6a0b4c7d1, as listPages returns it.
options.fromDate | string: The start of the window. Defaults to now.
options.toDate | string: The end of the window, later than from. Defaults to 14 days after from, and counts for at most 62 days after it.
options.durationMinutesnumber: The meeting length in minutes, one of the durations of the page. Defaults to the shortest.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Returns

BookingTimesResource with pageId, the timezone of the page, the durationMinutes the times are for, and times, every open start time in the window as an ISO 8601 instant in UTC.

Example

const from = new Date()const to = new Date(from.getTime() + 7 * 24 * 60 * 60 * 1000) const open = await openemail.bookings.listTimes('bkp_5c1e9a7b3d2f48e6a0b4c7d1', { from, to, durationMinutes: 30 }) for (const time of open.times) console.log(time)

Notes

A to that is not later than from and a durationMinutes the page does not offer are 422 invalid_parameter. A missing page is a 404 booking_page_not_found.
The times are instants, so show them to a person in a time zone: timezone names the one the hours of the page are read in.
It reads the calendar as it is now and holds nothing. A time it lists can be gone a moment later, when a guest books it.
A booking page belongs to one person. An API key acts as the workspace owner and reaches the pages of the owner, and a connected app reaches the pages of the person who connected it.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.

Also available in

API: GET /booking-pages/{id}/times
Python: bookings.list_times()
Ruby: bookings.list_times
PHP: bookings->listTimes
Go: Bookings.ListTimes
Java: bookings().listTimes
C#: Bookings.ListTimesAsync
CLI: openemail bookings list-times

`bookings.list()`

List the meetings guests booked, a page at a time

calendar:readPages through results

Signature

list(options?: BookingListOptions): Promise<Page<BookingResource>>

Resolves one page of bookings: the meetings guests booked on the booking pages of the person, or on one page with pageId. listAll collects every page and iterate walks them lazily. A booking is a calendar event with the guest invited, so it shows wherever the calendar does, and a meeting moved or cancelled in the calendar reads as moved or cancelled here.

view picks which bookings are listed. upcoming, the default, holds the confirmed meetings that are not over. pending holds the requests that wait for approve or decline, on a page whose config.approval is true. past holds the meetings that are over and the requests nobody answered in time, and ended holds the ones that were declined or cancelled. upcoming and pending come soonest first, past and ended latest first.

Each booking names its page in pageId and pageName, the guest in guest, what they answered in answers and its calendar event in eventId.

Parameters

options.viewBookingView: Which bookings to list: upcoming, pending, past or ended. Defaults to upcoming.
options.pageIdstring: Only the bookings of this booking page, by its id. Left out, the bookings of every page of the person are listed.
options.limitnumber: Page size, from 1 to 100. The server defaults to 30.
options.cursorstring: The nextCursor of the previous page, passed back as it came. Leave it out for the first page.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Returns

Page<BookingResource> with items, hasMore and nextCursor. Each item has id, pageId, pageName, status, expired, past, start, end, durationMinutes, guest, answers, location, eventId, endedBy, endReason, rescheduleCount, guestMailFailed and createdAt.

Example

const page = await openemail.bookings.list({ view: 'pending' }) for (const booking of page.items) {    console.log(booking.id, booking.pageName, booking.guest.name, booking.start)}

Notes

status is pending while a booking waits for approval, confirmed once the meeting stands, declined when a request was turned down and cancelled when a confirmed meeting was called off. expired is true for a request nobody answered before its time came, and past once the meeting is over.
A pageId that is not a page of the person answers 404 booking_page_not_found, and a cursor this list did not hand out 400 invalid_cursor.
The cursor marks how far into the view the last page reached. A booking that enters or leaves the view between two pages shifts the rows after it, so read the view again when an exact list matters.
An API key acts as the workspace owner and reads the bookings of the owner, and a connected app reads the bookings of the person who connected it. One guest address holds at most 3 upcoming bookings on a page.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.

Also available in

API: GET /bookings
Python: bookings.list()
Ruby: bookings.list
PHP: bookings->list
Go: Bookings.List
Java: bookings().list
C#: Bookings.ListAsync
CLI: openemail bookings list

`bookings.listAll()`

Collect every booking of a view into one array

calendar:readPages through results

Signature

listAll(options?: BookingListOptions): Promise<Array<BookingResource>>

Walks every page of list and resolves with all bookings of one view, in the order of that view: upcoming and pending soonest first, past and ended latest first. One request per page. Give pageId to collect only the bookings of one booking page.

Parameters

options.viewBookingView: Which bookings to collect: upcoming, pending, past or ended. Defaults to upcoming.
options.pageIdstring: Only the bookings of this booking page, by its id. Left out, the bookings of every page of the person are collected.
options.limitnumber: Page size for each request, from 1 to 100. The server defaults to 30.
options.cursorstring: Starts the walk after this cursor instead of the first page.
options.signalAbortSignal: Cancels the request in flight and the walk with it.
options.apiKeystring: Overrides the client API key for every page of this walk.

Returns

Array<BookingResource> holding every booking of the view.

Example

const bookings = await openemail.bookings.listAll({ view: 'upcoming', limit: 100 })const unsent = bookings.filter((booking) => booking.guestMailFailed) for (const booking of unsent) console.log(booking.id, booking.guest.email, booking.start)

Notes

If any page fails the promise rejects and the bookings already fetched are discarded.
The past and ended views grow without end, so prefer iterate there and stop when you have read far enough back.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.

Also available in

API: GET /bookings
Python: bookings.list_all()
Ruby: bookings.list_all
PHP: bookings->listAll
Go: Bookings.ListAll
Java: bookings().listAll
C#: Bookings.ListAllAsync

`bookings.iterate()`

Stream the bookings of a view one at a time

calendar:readPages through results

Signature

iterate(options?: BookingListOptions): AsyncGenerator<BookingResource, void, undefined>

Returns an async generator that yields the bookings of one view individually, in the order of that view, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests.

Parameters

options.viewBookingView: Which bookings to walk: upcoming, pending, past or ended. Defaults to upcoming.
options.pageIdstring: Only the bookings of this booking page, by its id. Left out, the bookings of every page of the person are walked.
options.limitnumber: Page size for each request, from 1 to 100. The server defaults to 30.
options.cursorstring: Starts the walk after this cursor instead of the first page.
options.signalAbortSignal: Cancels the request in flight and the walk with it.
options.apiKeystring: Overrides the client API key for every page of this walk.

Returns

AsyncGenerator<BookingResource, void, undefined> yielding one booking per step.

Example

for await (const booking of openemail.bookings.iterate({ view: 'ended' })) {    console.log(booking.start, booking.pageName, booking.endedBy, booking.endReason)}

Notes

The generator is lazy, so an abandoned loop costs only the pages you consumed.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.

Also available in

API: GET /bookings
Python: bookings.iterate()
Ruby: bookings.iterate
PHP: bookings->iterate
Go: Bookings.Iterate
Java: bookings().iterate
C#: Bookings.IterateAsync

`bookings.get()`

Read one booking by id

calendar:read

Signature

get(id: string, options?: RequestScope): Promise<BookingResource>

Looks up a single booking and returns it in the same shape as a row of list: the booking page it was made on, the guest with the time zone they booked in, what they answered to the questions of the page, where the meeting happens as the guest was told, the calendar event it is and how it ended if it did.

A booking follows its calendar event. Reading one first catches up with the calendar, so a meeting that was moved there shows its new start and end, and one that was cancelled or deleted there reads cancelled, or declined when it still waited for approval. endedBy says whether the host or the guest declined or cancelled it, and endReason holds the reason they gave. guestMailFailed is true when the last email to the guest could not be sent, and resendEmail tries again.

Parameters

idstringRequired: Booking id such as bkg_2b8d4f6a1c3e5079b6d8f0a2, as list returns it.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Returns

BookingResource with id, pageId, pageName, status, expired, past, start, end, durationMinutes, guest, answers, location, eventId, endedBy, endReason, rescheduleCount, guestMailFailed and createdAt.

Example

const booking = await openemail.bookings.get('bkg_2b8d4f6a1c3e5079b6d8f0a2') console.log(booking.status, booking.start, booking.guest.name, booking.guest.email) for (const answer of booking.answers) console.log(answer.label, answer.value)

Notes

A missing booking throws OpenEmailApiError with isNotFound true and code booking_not_found. A booking on a page that belongs to somebody else in the workspace is missing too.
eventId is the id calendar.getEvent reads. It is null once the booking ended and its event was removed.
Each answer carries the id, label and kind of its question as it was asked, and its value as text. A checkbox answers yes or no.
An API key acts as the workspace owner and reads the bookings of the owner, and a connected app reads the bookings of the person who connected it.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.

Also available in

API: GET /bookings/{id}
Python: bookings.get()
Ruby: bookings.get
PHP: bookings->get
Go: Bookings.Get
Java: bookings().get
C#: Bookings.GetAsync
CLI: openemail bookings get

`bookings.approve()`

Confirm a booking that waits for approval

calendar:writeemails:send

Signature

approve(id: string, options?: RequestScope): Promise<BookingResource>

Confirms a booking that waits for approval, on a booking page whose config.approval is true. The hold on the calendar becomes a confirmed meeting, and the guest is told by email, sent from the address of the page with the calendar invitation attached. It takes no body.

The email goes out as config.fromEmail, so the call needs emails:send beside calendar:write. list with view pending reads the bookings that wait.

Parameters

idstringRequired: Booking id such as bkg_2b8d4f6a1c3e5079b6d8f0a2, as list returns it.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Returns

BookingResource with status confirmed, and guestMailFailed saying whether the email to the guest went out.

Example

const booking = await openemail.bookings.approve('bkg_2b8d4f6a1c3e5079b6d8f0a2') console.log(booking.status, booking.start, booking.guestMailFailed)

Notes

A booking that is not waiting for approval answers 409 booking_not_pending, and one whose time has passed 409 booking_ended. A missing one is a 404 booking_not_found.
The booking is confirmed even when the email cannot be sent. guestMailFailed is then true, and resendEmail sends it again.
An API key acts as the workspace owner and reaches the bookings of the owner, and a connected app reaches the bookings of the person who connected it.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.
The SDK does not retry it, because a retry could email the guest twice. A 409 booking_not_pending on your own second attempt after a lost response means the first one worked or the guest withdrew, and get says which.

Also available in

API: POST /bookings/{id}/approve
Python: bookings.approve()
Ruby: bookings.approve
PHP: bookings->approve
Go: Bookings.Approve
Java: bookings().approve
C#: Bookings.ApproveAsync
CLI: openemail bookings approve

`bookings.decline()`

Turn down a booking that waits for approval

calendar:writeemails:send

Signature

decline(id: string, body?: BookingReason, options?: RequestScope): Promise<BookingResource>

Turns down a booking that waits for approval and frees its time, so the page offers that time again. The guest is told by email, sent from the address of the page, with reason in it when one is given. Call it with no body to decline without a reason.

The email goes out as config.fromEmail, so the call needs emails:send beside calendar:write.

Parameters

idstringRequired: Booking id such as bkg_2b8d4f6a1c3e5079b6d8f0a2, as list returns it.
body.reasonstring | null: A sentence for the guest, trimmed, at most 500 characters, included in the email they get. Left out or null, the email gives no reason.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Returns

BookingResource with status declined, endedBy host and endReason holding the reason, or null.

Example

const booking = await openemail.bookings.decline('bkg_2b8d4f6a1c3e5079b6d8f0a2', {    reason: 'I am away that week. Please pick a time after the 20th.'}) console.log(booking.status, booking.endReason)

Notes

A booking that is not waiting for approval answers 409 booking_not_pending. To call off a confirmed meeting, use cancel. A missing booking is a 404 booking_not_found.
A reason over 500 characters is 422 invalid_parameter, and a key the body does not take is 422 unknown_parameter.
The booking is declined even when the email cannot be sent. guestMailFailed is then true, and resendEmail sends it again.
An API key acts as the workspace owner and reaches the bookings of the owner, and a connected app reaches the bookings of the person who connected it.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.
The SDK does not retry it, because a retry could email the guest twice. A 409 booking_not_pending on your own second attempt after a lost response means the first one worked or somebody else answered, and get says which.

Also available in

API: POST /bookings/{id}/decline
Python: bookings.decline()
Ruby: bookings.decline
PHP: bookings->decline
Go: Bookings.Decline
Java: bookings().decline
C#: Bookings.DeclineAsync
CLI: openemail bookings decline

`bookings.cancel()`

Cancel a booked meeting

calendar:writeemails:send

Signature

cancel(id: string, body?: BookingReason, options?: RequestScope): Promise<BookingResource>

Cancels a meeting that has not ended yet and cancels its calendar event. The guest is told by email, sent from the address of the page with the cancellation attached, and with reason in it when one is given. Call it with no body to cancel without a reason.

A booking that still waits for approval is declined instead, so it ends as declined, not cancelled. The email goes out as config.fromEmail, so the call needs emails:send beside calendar:write.

Parameters

idstringRequired: Booking id such as bkg_2b8d4f6a1c3e5079b6d8f0a2, as list returns it.
body.reasonstring | null: A sentence for the guest, trimmed, at most 500 characters, included in the email they get. Left out or null, the email gives no reason.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Returns

BookingResource with status cancelled, or declined when it still waited for approval, endedBy host and endReason holding the reason, or null.

Example

const booking = await openemail.bookings.cancel('bkg_2b8d4f6a1c3e5079b6d8f0a2', {    reason: 'Something urgent came up. Please book another time.'}) console.log(booking.status, booking.endedBy, booking.endReason)

Notes

A booking that was already declined or cancelled, or whose meeting is over, answers 409 booking_ended. A missing one is a 404 booking_not_found.
There is no undo. The time is free again and the guest has to book once more.
A reason over 500 characters is 422 invalid_parameter, and a key the body does not take is 422 unknown_parameter.
The booking is cancelled even when the email cannot be sent. guestMailFailed is then true, and resendEmail sends it again.
An API key acts as the workspace owner and reaches the bookings of the owner, and a connected app reaches the bookings of the person who connected it.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.
The SDK does not retry it, because a retry could email the guest twice. A 409 booking_ended on your own second attempt after a lost response means the first one worked or the guest cancelled, and get says which.

Also available in

API: POST /bookings/{id}/cancel
Python: bookings.cancel()
Ruby: bookings.cancel
PHP: bookings->cancel
Go: Bookings.Cancel
Java: bookings().cancel
C#: Bookings.CancelAsync
CLI: openemail bookings cancel

`bookings.resendEmail()`

Send the guest the email about their booking again

calendar:writeemails:send

Signature

resendEmail(id: string, options?: RequestScope): Promise<BookingResource>

Sends the guest the email that matches where the booking stands now: the request while it waits for approval, the confirmation with its invitation once it is confirmed, or the notice that it was declined or cancelled, with the reason that was given. Use it when guestMailFailed is true. It takes no body and changes nothing else about the booking.

Parameters

idstringRequired: Booking id such as bkg_2b8d4f6a1c3e5079b6d8f0a2, as list returns it.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Returns

BookingResource with guestMailFailed as it is after the send: false when the email went out, true when it failed again.

Example

const booking = await openemail.bookings.resendEmail('bkg_2b8d4f6a1c3e5079b6d8f0a2') if (booking.guestMailFailed) console.log('Still not sent to', booking.guest.email)

Notes

A missing booking is a 404 booking_not_found.
It answers 200 whether or not the email went out, so read guestMailFailed to know.
An API key acts as the workspace owner and reaches the bookings of the owner, and a connected app reaches the bookings of the person who connected it.
A key or an app limited to particular addresses or domains is refused with 422 capability_unsupported, because a booking page reads the whole calendar of its person.
Not retried automatically: every call sends another email, so a retry after a lost response can reach the guest twice.

Also available in

API: POST /bookings/{id}/resend
Python: bookings.resend_email()
Ruby: bookings.resend_email
PHP: bookings->resendEmail
Go: Bookings.ResendEmail
Java: bookings().resendEmail
C#: Bookings.ResendEmailAsync
CLI: openemail bookings resend-email

openemail.bookings

Methods

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Your inbox,on your own terms.

Your inbox,
on your own terms.