Skip to content

YouCanBook.me

The YouCanBook.me modules enable you to monitor, retrieve, create, update, and delete profiles and bookings in your YouCanBook.me account.

Getting Started With YouCanBook.me

Prerequisites

Connecting YouCanBook.me to Ibexa Connect

To connect your YouCanBook.me account to Ibexa Connect, you need to enter your YouCanBook.me credentials in the Create a connection dialog in Ibexa Connect.

1. In Ibexa Connect, open the YouCanBook.me module's Create a connection dialog.

61f27e93de282.png

2. Enter your YouCanBook.me email address and password, and click Continue.

Note

https://app.youcanbook.me/#/account?show=password

3. The connection has been established.

Profile

Watch Profiles

Retrieves profile details when a profile is created or updated.

Watch Profiles Select whether you want to watch new profiles (By Creation Time) or updated profiles (By Updated Time).
Limit Set the maximum number of profiles Ibexa Connect will return during one execution cycle.

List Profiles

Retrieves all profiles in your YouCanBook.me account.

Limit Set the maximum number of profiles Ibexa Connect will return during one execution cycle.

Get a Profile

Retrieves profile details.

Profile ID Select or enter (map) the ID of the profile you want to retrieve details about.

Create a Profile

Creates a new profile (booking page).

Title

Enter the name of the new profile.

Sub Domain

Enter the new subdomain for your YouCanBook.me profile.

Status

Select the status of the new booking page.

Description

Enter the description of the booking page.

Logo URL

Provide a URL of the logo to be used for the new booking page.

  • PNG, JPEG, GIF, BMP accepted

  • Max size 2000 x 2000

  • Max file size 2MB

Update a Profile

Updates an existing profile.

Profile ID

Select or map the profile you want to update.

Title

Enter the name of the new profile.

Sub Domain

Enter the new subdomain for your YouCanBook.me profile.

Status

Select the status of the new booking page.

Description

Enter the description of the booking page.

Logo URL

Provide a URL of the logo to be used for the new booking page.

  • PNG, JPEG, GIF, BMP accepted

  • Max size 2000 x 2000

  • Max file size 2MB

Delete a Profile

Deletes a profile.

Profile ID Select or enter (map) the ID of the profile you want to delete.

Booking

Watch Bookings

Retrieves booking details when a booking is created, rescheduled, or canceled.

Watch Bookings Select whether you want to watch new booking profiles (By Creation Time), rescheduled bookings (By Reschedule Time), or canceled bookings (By Cancellation Time).
Profile ID Select the profile you want to watch bookings for.
Search Enter the term to filter returned results by.
Limit Set the maximum number of bookings Ibexa Connect will return during one execution cycle.

List Bookings

Retrieves all bookings for the specified profile.

Profile ID Select the profile you want to list bookings for.
Search Enter the term to filter returned results by.
Limit Set the maximum number of bookings Ibexa Connect will return during one execution cycle.

Get a Booking

Retrieves booking details.

Profile ID Map or select the profile that contains the booking you want to retrieve details for.
Booking ID Select or enter (map) the ID of the booking you want to retrieve details about.

Create a Booking

Creates a booking for the booking page (profile).

The Captcha Test must be turned off for the booking form to use this module.

61f27e9547c58.png

Profile ID Select the profile you want to create a booking for.
Title Enter the title for the booking.
Receiver's Email Enter the subscriber's email.
Starts at Enter the start time of the booking. See the list of supported date and time formats.
Duration (Minutes) Enter the duration of the booking.
Time Zone Select the time zone of the booking.
Answers Specify answers for booking questions.

You can find shorthand codes in the web UI:

61f27e9659abf.png

Example of Answers:

61f27e9776168.png

Delete a Booking

Deletes a booking.

Profile ID Map or select the profile that contains the booking you want to delete.
Booking ID Select or enter (map) the ID of the booking you want to delete.

Make an API Call

Allows you to perform a custom API call.

URL

Enter a path relative to https://api.youcanbook.me.For example: /v1/{username}/profiles.

For the list of available endpoints, refer to the YouCanBook.me API Documentation.

Method

Select the HTTP method you want to use:

GETto retrieve information for an entry.

POSTto create a new entry.

PUTto update/replace an existing entry.

PATCHto make a partial entry update.

DELETEto delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we've already added those for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List Profiles

The following API call returns all profiles in your YouCanBook.me account:

URL:/v1/{username}/profiles

Method:GET

61f27e98654de.png

The result can be found in the module's Output under Bundle > Body. In our example, 4 profiles were returned:

61f27e9969a05.png