Overview
The "Create a meeting" API allows users to create meeting-links.
Usage
Base URL
https://<workspace>.neetocal.com/api/external/v1
Replace the <workspace>
with your workspace's subdomain.
Endpoint
POST /meetings
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 slug of the meeting link that you want to create. This value should be unique. |
|
String |
Yes |
The name of the meeting link |
|
String |
No |
The name of the meeting link |
|
String |
Yes |
Array of email of hosts in the meeting. |
|
String |
No |
Kind of meeting. Available kinds are one_on_one, round_robin, and multihost. Defaults to one_on_one. |
|
Integer |
Yes |
Duration of the meeting. |
|
Integer |
No |
Start time increment for the meeting. Defaults to 30. |
Example
For creating a 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/meetings' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"slug": "meeting-with-oliver-smith",
"name": "Meeting with Oliver Smith",
"spot": "zoom",
"duration": "60",
"hosts": ["[email protected]"]
}'
Response Codes
Code |
Description |
---|---|
200 |
OK - Request succeeded |
400 |
Bad Request - Missing/Invalid parameters |
401 |
Unauthorized - Invalid API key |
500 |
Internal server error |