Making a booking

Overview

The "Making a booking" API allows users to book for a specific meeting, in a particular slot.

Usage

Base URL

https://<workspace>.neetocal.com/api/external/v1

Replace the <workspace> with your workspace's subdomain.

Endpoint

POST /bookings

Request header

This endpoint requires authentication. You must include a valid API key in the request header.

Header

Type

Required

Description

X-Api-Key

String

Yes

Bearer token for API access.

Request body

Key

Type

Required

Description

meeting_slug

String

Yes

The slug of the meeting link that you need to book

name

String

Yes

The name of the person making the booking

email

String

Yes

The email of the person making the booking

slot_date

String

Yes

Date on which the booking is scheduled. This should be in "YYYY-MM-DD" format. Examples: 2024-07-14, 2024-06-12

slot_start_time

String

Yes

Start time for the booking. This should be in "HH::MM AM/PM". Examples: 01:00 PM, 07:40 PM

time_zone

String

Yes

The time zone in which to book the meeting.

form_responses

String

No

Other form responses. More details given below.

form_responses: If the meeting form has questions other than name, and email this field can be used. It should be a string that contains a JSON. The keys of the JSON should be the field_code value of the corresponding questions. The field_code can be obtained by going to the "Configure" particular meeting-link by logging in as an admin and selecting the "Questions" card. To get the field_code of a given question, click on triple dots on the right side of the question, and from the pane click on the "Advanced properties" dropdown. You will be able to get the field_code from there. The JSON should be of the following format

{
  "introduction": "Hi I am Eve", 
  "platform": "LinkedIn" 
  "languages": ["Python", "Java"],
}

In the above example, introduction is a field_code of a text_area question. platform is a field_code for a single-choice question. For such types of questions, the answer should be inside a string. languages is a field_code for a multiple-choice question, and in such cases, the answers must be an array of strings. The string value for all the questions that have options should be the exact value of the option.

Example

For making a booking for the meeting, "Meeting with Oliver Smith", with the slug meeting-with-oliver-smith of workspace "Spinkart" with subdomain spinkart using curl

curl --request POST \
  --url 'https://spinkart.neetocal.com/api/external/v1/bookings' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "meeting_slug": "meeting-with-oliver-smith",
    "name": "Eve Smith",
    "email": "[email protected]",
    "time_zone": "Asia/Calcutta",
    "form_responses": {
      "introduction": "Hi I am Eve",
      "languages": ["Python", "Java"],
      "platform": "LinkedIn"
    },
    "slot_date": "2024-07-15",
    "slot_start_time": "01:30 PM"
  }'

Response Codes

Code

Description

200

OK - Request succeeded

400

Bad Request - Missing/Invalid parameters

401

Unauthorized - Invalid API key

500

Internal server error

Can't find what you're looking for?