The "Rescheduling a booking" API allows users to reschedule an existing booking to a different slot.
Usage
Base URL
https://<workspace>.neetocal.com/api/external/v1
Replace the <workspace>
with your workspace's subdomain.
Endpoint
PATCH /bookings/<booking_sid>
Replace the <booking_sid>
with the booking SID that you want to reschedule.
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 |
---|---|---|---|
|
String |
Yes |
The name of the person making the booking |
|
String |
Yes |
The email of the person making the booking |
|
String |
Yes |
The new date to which the booking is to be rescheduled to. This should be in "YYYY-MM-DD" format. Examples: |
|
String |
Yes |
New start time for the booking. This should be in "HH::MM AM/PM". Examples: |
|
String |
Yes |
The time zone in which to book the meeting. |
|
String |
No |
Other form responses. More details given below. |
reschedule_reason |
String |
No |
The reason for rescheduling the booking |
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 rescheduling a booking with sid uyn96hk
, of workspace "Spinkart" with subdomain spinkart
using curl
curl --request PATCH \
--url 'https://spinkart.neetocal.com/api/external/v1/bookings/uyn96hk' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"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-25",
"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 |