Create a team Event
curl --request POST \
--url https://api.cal.com/v2/teams/{teamId}/events \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "Team offsite",
"startTime": "2030-01-01T10:00:00.000Z",
"endTime": "2030-01-01T11:00:00.000Z",
"timeZone": "Europe/Berlin",
"slug": "team-offsite-2030",
"description": "<string>",
"visibility": "PUBLIC",
"capacity": 50000.5,
"waitlistEnabled": false,
"paymentTimeoutMinutes": 5045,
"requiresApproval": false,
"showOrganizerEmail": true,
"guestList": "names",
"showPresentedBy": true,
"background": {
"colors": [
"#0b1c2c",
"#1f6feb",
"#a5d8ff"
]
},
"lineup": {
"people": [
{
"name": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"links": [
{
"url": "<string>"
}
],
"media": [
{
"url": "<string>",
"label": "<string>"
}
]
}
],
"title": "<string>"
},
"schedule": [
{
"content": "<string>",
"startTime": "2030-01-01T10:10:00.000Z",
"endTime": "2030-01-01T10:40:00.000Z",
"timeLabel": "<string>",
"people": [
{
"name": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"links": [
{
"url": "<string>"
}
]
}
]
}
],
"registrationFields": [
{
"field": "name",
"variant": "fullName",
"slug": "name",
"label": "<string>",
"placeholder": "<string>",
"disableOnPrefill": true
}
],
"hosts": [
{
"userId": 123
}
],
"liveStreams": [
{
"url": "<string>"
}
],
"locations": [
{
"type": "address",
"address": "1 Example Street, Berlin",
"label": "<string>",
"price": 1500,
"currency": "usd",
"capacity": 50000.5
}
]
}
'import requests
url = "https://api.cal.com/v2/teams/{teamId}/events"
payload = {
"title": "Team offsite",
"startTime": "2030-01-01T10:00:00.000Z",
"endTime": "2030-01-01T11:00:00.000Z",
"timeZone": "Europe/Berlin",
"slug": "team-offsite-2030",
"description": "<string>",
"visibility": "PUBLIC",
"capacity": 50000.5,
"waitlistEnabled": False,
"paymentTimeoutMinutes": 5045,
"requiresApproval": False,
"showOrganizerEmail": True,
"guestList": "names",
"showPresentedBy": True,
"background": { "colors": ["#0b1c2c", "#1f6feb", "#a5d8ff"] },
"lineup": {
"people": [
{
"name": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"links": [{ "url": "<string>" }],
"media": [
{
"url": "<string>",
"label": "<string>"
}
]
}
],
"title": "<string>"
},
"schedule": [
{
"content": "<string>",
"startTime": "2030-01-01T10:10:00.000Z",
"endTime": "2030-01-01T10:40:00.000Z",
"timeLabel": "<string>",
"people": [
{
"name": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"links": [{ "url": "<string>" }]
}
]
}
],
"registrationFields": [
{
"field": "name",
"variant": "fullName",
"slug": "name",
"label": "<string>",
"placeholder": "<string>",
"disableOnPrefill": True
}
],
"hosts": [{ "userId": 123 }],
"liveStreams": [{ "url": "<string>" }],
"locations": [
{
"type": "address",
"address": "1 Example Street, Berlin",
"label": "<string>",
"price": 1500,
"currency": "usd",
"capacity": 50000.5
}
]
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Team offsite',
startTime: '2030-01-01T10:00:00.000Z',
endTime: '2030-01-01T11:00:00.000Z',
timeZone: 'Europe/Berlin',
slug: 'team-offsite-2030',
description: '<string>',
visibility: 'PUBLIC',
capacity: 50000.5,
waitlistEnabled: false,
paymentTimeoutMinutes: 5045,
requiresApproval: false,
showOrganizerEmail: true,
guestList: 'names',
showPresentedBy: true,
background: {colors: ['#0b1c2c', '#1f6feb', '#a5d8ff']},
lineup: {
people: [
{
name: '<string>',
role: '<string>',
avatarUrl: '<string>',
links: [{url: '<string>'}],
media: [{url: '<string>', label: '<string>'}]
}
],
title: '<string>'
},
schedule: [
{
content: '<string>',
startTime: '2030-01-01T10:10:00.000Z',
endTime: '2030-01-01T10:40:00.000Z',
timeLabel: '<string>',
people: [
{
name: '<string>',
role: '<string>',
avatarUrl: '<string>',
links: [{url: '<string>'}]
}
]
}
],
registrationFields: [
{
field: 'name',
variant: 'fullName',
slug: 'name',
label: '<string>',
placeholder: '<string>',
disableOnPrefill: true
}
],
hosts: [{userId: 123}],
liveStreams: [{url: '<string>'}],
locations: [
{
type: 'address',
address: '1 Example Street, Berlin',
label: '<string>',
price: 1500,
currency: 'usd',
capacity: 50000.5
}
]
})
};
fetch('https://api.cal.com/v2/teams/{teamId}/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cal.com/v2/teams/{teamId}/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'Team offsite',
'startTime' => '2030-01-01T10:00:00.000Z',
'endTime' => '2030-01-01T11:00:00.000Z',
'timeZone' => 'Europe/Berlin',
'slug' => 'team-offsite-2030',
'description' => '<string>',
'visibility' => 'PUBLIC',
'capacity' => 50000.5,
'waitlistEnabled' => false,
'paymentTimeoutMinutes' => 5045,
'requiresApproval' => false,
'showOrganizerEmail' => true,
'guestList' => 'names',
'showPresentedBy' => true,
'background' => [
'colors' => [
'#0b1c2c',
'#1f6feb',
'#a5d8ff'
]
],
'lineup' => [
'people' => [
[
'name' => '<string>',
'role' => '<string>',
'avatarUrl' => '<string>',
'links' => [
[
'url' => '<string>'
]
],
'media' => [
[
'url' => '<string>',
'label' => '<string>'
]
]
]
],
'title' => '<string>'
],
'schedule' => [
[
'content' => '<string>',
'startTime' => '2030-01-01T10:10:00.000Z',
'endTime' => '2030-01-01T10:40:00.000Z',
'timeLabel' => '<string>',
'people' => [
[
'name' => '<string>',
'role' => '<string>',
'avatarUrl' => '<string>',
'links' => [
[
'url' => '<string>'
]
]
]
]
]
],
'registrationFields' => [
[
'field' => 'name',
'variant' => 'fullName',
'slug' => 'name',
'label' => '<string>',
'placeholder' => '<string>',
'disableOnPrefill' => true
]
],
'hosts' => [
[
'userId' => 123
]
],
'liveStreams' => [
[
'url' => '<string>'
]
],
'locations' => [
[
'type' => 'address',
'address' => '1 Example Street, Berlin',
'label' => '<string>',
'price' => 1500,
'currency' => 'usd',
'capacity' => 50000.5
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cal.com/v2/teams/{teamId}/events"
payload := strings.NewReader("{\n \"title\": \"Team offsite\",\n \"startTime\": \"2030-01-01T10:00:00.000Z\",\n \"endTime\": \"2030-01-01T11:00:00.000Z\",\n \"timeZone\": \"Europe/Berlin\",\n \"slug\": \"team-offsite-2030\",\n \"description\": \"<string>\",\n \"visibility\": \"PUBLIC\",\n \"capacity\": 50000.5,\n \"waitlistEnabled\": false,\n \"paymentTimeoutMinutes\": 5045,\n \"requiresApproval\": false,\n \"showOrganizerEmail\": true,\n \"guestList\": \"names\",\n \"showPresentedBy\": true,\n \"background\": {\n \"colors\": [\n \"#0b1c2c\",\n \"#1f6feb\",\n \"#a5d8ff\"\n ]\n },\n \"lineup\": {\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"links\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"media\": [\n {\n \"url\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"title\": \"<string>\"\n },\n \"schedule\": [\n {\n \"content\": \"<string>\",\n \"startTime\": \"2030-01-01T10:10:00.000Z\",\n \"endTime\": \"2030-01-01T10:40:00.000Z\",\n \"timeLabel\": \"<string>\",\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"links\": [\n {\n \"url\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"registrationFields\": [\n {\n \"field\": \"name\",\n \"variant\": \"fullName\",\n \"slug\": \"name\",\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"disableOnPrefill\": true\n }\n ],\n \"hosts\": [\n {\n \"userId\": 123\n }\n ],\n \"liveStreams\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"locations\": [\n {\n \"type\": \"address\",\n \"address\": \"1 Example Street, Berlin\",\n \"label\": \"<string>\",\n \"price\": 1500,\n \"currency\": \"usd\",\n \"capacity\": 50000.5\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cal.com/v2/teams/{teamId}/events")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Team offsite\",\n \"startTime\": \"2030-01-01T10:00:00.000Z\",\n \"endTime\": \"2030-01-01T11:00:00.000Z\",\n \"timeZone\": \"Europe/Berlin\",\n \"slug\": \"team-offsite-2030\",\n \"description\": \"<string>\",\n \"visibility\": \"PUBLIC\",\n \"capacity\": 50000.5,\n \"waitlistEnabled\": false,\n \"paymentTimeoutMinutes\": 5045,\n \"requiresApproval\": false,\n \"showOrganizerEmail\": true,\n \"guestList\": \"names\",\n \"showPresentedBy\": true,\n \"background\": {\n \"colors\": [\n \"#0b1c2c\",\n \"#1f6feb\",\n \"#a5d8ff\"\n ]\n },\n \"lineup\": {\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"links\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"media\": [\n {\n \"url\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"title\": \"<string>\"\n },\n \"schedule\": [\n {\n \"content\": \"<string>\",\n \"startTime\": \"2030-01-01T10:10:00.000Z\",\n \"endTime\": \"2030-01-01T10:40:00.000Z\",\n \"timeLabel\": \"<string>\",\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"links\": [\n {\n \"url\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"registrationFields\": [\n {\n \"field\": \"name\",\n \"variant\": \"fullName\",\n \"slug\": \"name\",\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"disableOnPrefill\": true\n }\n ],\n \"hosts\": [\n {\n \"userId\": 123\n }\n ],\n \"liveStreams\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"locations\": [\n {\n \"type\": \"address\",\n \"address\": \"1 Example Street, Berlin\",\n \"label\": \"<string>\",\n \"price\": 1500,\n \"currency\": \"usd\",\n \"capacity\": 50000.5\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cal.com/v2/teams/{teamId}/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Team offsite\",\n \"startTime\": \"2030-01-01T10:00:00.000Z\",\n \"endTime\": \"2030-01-01T11:00:00.000Z\",\n \"timeZone\": \"Europe/Berlin\",\n \"slug\": \"team-offsite-2030\",\n \"description\": \"<string>\",\n \"visibility\": \"PUBLIC\",\n \"capacity\": 50000.5,\n \"waitlistEnabled\": false,\n \"paymentTimeoutMinutes\": 5045,\n \"requiresApproval\": false,\n \"showOrganizerEmail\": true,\n \"guestList\": \"names\",\n \"showPresentedBy\": true,\n \"background\": {\n \"colors\": [\n \"#0b1c2c\",\n \"#1f6feb\",\n \"#a5d8ff\"\n ]\n },\n \"lineup\": {\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"links\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"media\": [\n {\n \"url\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"title\": \"<string>\"\n },\n \"schedule\": [\n {\n \"content\": \"<string>\",\n \"startTime\": \"2030-01-01T10:10:00.000Z\",\n \"endTime\": \"2030-01-01T10:40:00.000Z\",\n \"timeLabel\": \"<string>\",\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"links\": [\n {\n \"url\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"registrationFields\": [\n {\n \"field\": \"name\",\n \"variant\": \"fullName\",\n \"slug\": \"name\",\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"disableOnPrefill\": true\n }\n ],\n \"hosts\": [\n {\n \"userId\": 123\n }\n ],\n \"liveStreams\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"locations\": [\n {\n \"type\": \"address\",\n \"address\": \"1 Example Street, Berlin\",\n \"label\": \"<string>\",\n \"price\": 1500,\n \"currency\": \"usd\",\n \"capacity\": 50000.5\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"uuid": "<string>",
"slug": "<string>",
"title": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"checkInOpensAt": "2023-11-07T05:31:56Z",
"checkInClosesAt": "2023-11-07T05:31:56Z",
"timeZone": "<string>",
"visibility": "PUBLIC",
"category": "meetup",
"hidden": true,
"status": "draft",
"locations": [
{
"id": "<string>",
"price": 2500,
"currency": "usd",
"type": "address",
"address": "123 Event Street",
"label": "<string>",
"capacity": 50000.5
}
],
"requiresApproval": true,
"waitlistEnabled": true,
"showOrganizerEmail": true,
"guestList": "hidden",
"showPresentedBy": true,
"liveStreams": [
{
"url": "<string>"
}
],
"registrationFields": [
{
"field": "name",
"slug": "name",
"variant": "fullName",
"disableOnPrefill": true,
"label": "<string>",
"placeholder": "<string>"
}
],
"hosts": [
{
"userId": 123,
"name": "Jane Doe",
"username": "jane",
"avatarUrl": "<string>"
}
],
"description": "<string>",
"publishedAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"coverImageUrl": "<string>",
"paymentTimeoutMinutes": 123,
"confirmedCount": 123,
"theme": "light",
"poster": {
"layout": "date",
"palette": {
"background": "#0b1c2c",
"foreground": "#a5d8ff",
"accent": "#1f6feb"
},
"headline": "<string>",
"seed": 123
},
"lineup": {
"title": "<string>",
"people": [
{
"name": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"links": [
{
"url": "<string>"
}
],
"media": [
{
"url": "<string>",
"label": "<string>"
}
]
}
]
},
"schedule": [
{
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"timeLabel": "<string>",
"content": "<string>",
"people": [
{
"name": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"links": [
{
"url": "<string>"
}
]
}
]
}
],
"background": {
"effect": "aurora",
"colors": [
"<string>"
]
},
"capacity": 100,
"cancellationReason": "<string>",
"userId": 123,
"teamId": 123
}
}Teams
Create a team Event
Creates a draft Event owned by the team. A draft is not public and nobody can register until it is published with POST /v2/events/{uuid}/publish. The user must be an accepted member of the team, or of its parent organization. PBAC permission: calEvent.create. Learn more about API access control at https://cal.com/docs/api-reference/v2/access-control.
startTime and endTime are ISO 8601 in UTC; startTime must not be in the past and endTime must be after startTime.
guestList controls whether guests see names, a count, or neither. locations sets where the Event happens; set price and currency on a location to charge for that place.
Events are fixed-date RSVP pages served at cal.com/; they are not event types (bookable meeting templates) or calendar events.
If accessed using an OAuth access token, the TEAM_EVENT_WRITE scope is required.
POST
/
v2
/
teams
/
{teamId}
/
events
Create a team Event
curl --request POST \
--url https://api.cal.com/v2/teams/{teamId}/events \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "Team offsite",
"startTime": "2030-01-01T10:00:00.000Z",
"endTime": "2030-01-01T11:00:00.000Z",
"timeZone": "Europe/Berlin",
"slug": "team-offsite-2030",
"description": "<string>",
"visibility": "PUBLIC",
"capacity": 50000.5,
"waitlistEnabled": false,
"paymentTimeoutMinutes": 5045,
"requiresApproval": false,
"showOrganizerEmail": true,
"guestList": "names",
"showPresentedBy": true,
"background": {
"colors": [
"#0b1c2c",
"#1f6feb",
"#a5d8ff"
]
},
"lineup": {
"people": [
{
"name": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"links": [
{
"url": "<string>"
}
],
"media": [
{
"url": "<string>",
"label": "<string>"
}
]
}
],
"title": "<string>"
},
"schedule": [
{
"content": "<string>",
"startTime": "2030-01-01T10:10:00.000Z",
"endTime": "2030-01-01T10:40:00.000Z",
"timeLabel": "<string>",
"people": [
{
"name": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"links": [
{
"url": "<string>"
}
]
}
]
}
],
"registrationFields": [
{
"field": "name",
"variant": "fullName",
"slug": "name",
"label": "<string>",
"placeholder": "<string>",
"disableOnPrefill": true
}
],
"hosts": [
{
"userId": 123
}
],
"liveStreams": [
{
"url": "<string>"
}
],
"locations": [
{
"type": "address",
"address": "1 Example Street, Berlin",
"label": "<string>",
"price": 1500,
"currency": "usd",
"capacity": 50000.5
}
]
}
'import requests
url = "https://api.cal.com/v2/teams/{teamId}/events"
payload = {
"title": "Team offsite",
"startTime": "2030-01-01T10:00:00.000Z",
"endTime": "2030-01-01T11:00:00.000Z",
"timeZone": "Europe/Berlin",
"slug": "team-offsite-2030",
"description": "<string>",
"visibility": "PUBLIC",
"capacity": 50000.5,
"waitlistEnabled": False,
"paymentTimeoutMinutes": 5045,
"requiresApproval": False,
"showOrganizerEmail": True,
"guestList": "names",
"showPresentedBy": True,
"background": { "colors": ["#0b1c2c", "#1f6feb", "#a5d8ff"] },
"lineup": {
"people": [
{
"name": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"links": [{ "url": "<string>" }],
"media": [
{
"url": "<string>",
"label": "<string>"
}
]
}
],
"title": "<string>"
},
"schedule": [
{
"content": "<string>",
"startTime": "2030-01-01T10:10:00.000Z",
"endTime": "2030-01-01T10:40:00.000Z",
"timeLabel": "<string>",
"people": [
{
"name": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"links": [{ "url": "<string>" }]
}
]
}
],
"registrationFields": [
{
"field": "name",
"variant": "fullName",
"slug": "name",
"label": "<string>",
"placeholder": "<string>",
"disableOnPrefill": True
}
],
"hosts": [{ "userId": 123 }],
"liveStreams": [{ "url": "<string>" }],
"locations": [
{
"type": "address",
"address": "1 Example Street, Berlin",
"label": "<string>",
"price": 1500,
"currency": "usd",
"capacity": 50000.5
}
]
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Team offsite',
startTime: '2030-01-01T10:00:00.000Z',
endTime: '2030-01-01T11:00:00.000Z',
timeZone: 'Europe/Berlin',
slug: 'team-offsite-2030',
description: '<string>',
visibility: 'PUBLIC',
capacity: 50000.5,
waitlistEnabled: false,
paymentTimeoutMinutes: 5045,
requiresApproval: false,
showOrganizerEmail: true,
guestList: 'names',
showPresentedBy: true,
background: {colors: ['#0b1c2c', '#1f6feb', '#a5d8ff']},
lineup: {
people: [
{
name: '<string>',
role: '<string>',
avatarUrl: '<string>',
links: [{url: '<string>'}],
media: [{url: '<string>', label: '<string>'}]
}
],
title: '<string>'
},
schedule: [
{
content: '<string>',
startTime: '2030-01-01T10:10:00.000Z',
endTime: '2030-01-01T10:40:00.000Z',
timeLabel: '<string>',
people: [
{
name: '<string>',
role: '<string>',
avatarUrl: '<string>',
links: [{url: '<string>'}]
}
]
}
],
registrationFields: [
{
field: 'name',
variant: 'fullName',
slug: 'name',
label: '<string>',
placeholder: '<string>',
disableOnPrefill: true
}
],
hosts: [{userId: 123}],
liveStreams: [{url: '<string>'}],
locations: [
{
type: 'address',
address: '1 Example Street, Berlin',
label: '<string>',
price: 1500,
currency: 'usd',
capacity: 50000.5
}
]
})
};
fetch('https://api.cal.com/v2/teams/{teamId}/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cal.com/v2/teams/{teamId}/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'Team offsite',
'startTime' => '2030-01-01T10:00:00.000Z',
'endTime' => '2030-01-01T11:00:00.000Z',
'timeZone' => 'Europe/Berlin',
'slug' => 'team-offsite-2030',
'description' => '<string>',
'visibility' => 'PUBLIC',
'capacity' => 50000.5,
'waitlistEnabled' => false,
'paymentTimeoutMinutes' => 5045,
'requiresApproval' => false,
'showOrganizerEmail' => true,
'guestList' => 'names',
'showPresentedBy' => true,
'background' => [
'colors' => [
'#0b1c2c',
'#1f6feb',
'#a5d8ff'
]
],
'lineup' => [
'people' => [
[
'name' => '<string>',
'role' => '<string>',
'avatarUrl' => '<string>',
'links' => [
[
'url' => '<string>'
]
],
'media' => [
[
'url' => '<string>',
'label' => '<string>'
]
]
]
],
'title' => '<string>'
],
'schedule' => [
[
'content' => '<string>',
'startTime' => '2030-01-01T10:10:00.000Z',
'endTime' => '2030-01-01T10:40:00.000Z',
'timeLabel' => '<string>',
'people' => [
[
'name' => '<string>',
'role' => '<string>',
'avatarUrl' => '<string>',
'links' => [
[
'url' => '<string>'
]
]
]
]
]
],
'registrationFields' => [
[
'field' => 'name',
'variant' => 'fullName',
'slug' => 'name',
'label' => '<string>',
'placeholder' => '<string>',
'disableOnPrefill' => true
]
],
'hosts' => [
[
'userId' => 123
]
],
'liveStreams' => [
[
'url' => '<string>'
]
],
'locations' => [
[
'type' => 'address',
'address' => '1 Example Street, Berlin',
'label' => '<string>',
'price' => 1500,
'currency' => 'usd',
'capacity' => 50000.5
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cal.com/v2/teams/{teamId}/events"
payload := strings.NewReader("{\n \"title\": \"Team offsite\",\n \"startTime\": \"2030-01-01T10:00:00.000Z\",\n \"endTime\": \"2030-01-01T11:00:00.000Z\",\n \"timeZone\": \"Europe/Berlin\",\n \"slug\": \"team-offsite-2030\",\n \"description\": \"<string>\",\n \"visibility\": \"PUBLIC\",\n \"capacity\": 50000.5,\n \"waitlistEnabled\": false,\n \"paymentTimeoutMinutes\": 5045,\n \"requiresApproval\": false,\n \"showOrganizerEmail\": true,\n \"guestList\": \"names\",\n \"showPresentedBy\": true,\n \"background\": {\n \"colors\": [\n \"#0b1c2c\",\n \"#1f6feb\",\n \"#a5d8ff\"\n ]\n },\n \"lineup\": {\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"links\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"media\": [\n {\n \"url\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"title\": \"<string>\"\n },\n \"schedule\": [\n {\n \"content\": \"<string>\",\n \"startTime\": \"2030-01-01T10:10:00.000Z\",\n \"endTime\": \"2030-01-01T10:40:00.000Z\",\n \"timeLabel\": \"<string>\",\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"links\": [\n {\n \"url\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"registrationFields\": [\n {\n \"field\": \"name\",\n \"variant\": \"fullName\",\n \"slug\": \"name\",\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"disableOnPrefill\": true\n }\n ],\n \"hosts\": [\n {\n \"userId\": 123\n }\n ],\n \"liveStreams\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"locations\": [\n {\n \"type\": \"address\",\n \"address\": \"1 Example Street, Berlin\",\n \"label\": \"<string>\",\n \"price\": 1500,\n \"currency\": \"usd\",\n \"capacity\": 50000.5\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cal.com/v2/teams/{teamId}/events")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Team offsite\",\n \"startTime\": \"2030-01-01T10:00:00.000Z\",\n \"endTime\": \"2030-01-01T11:00:00.000Z\",\n \"timeZone\": \"Europe/Berlin\",\n \"slug\": \"team-offsite-2030\",\n \"description\": \"<string>\",\n \"visibility\": \"PUBLIC\",\n \"capacity\": 50000.5,\n \"waitlistEnabled\": false,\n \"paymentTimeoutMinutes\": 5045,\n \"requiresApproval\": false,\n \"showOrganizerEmail\": true,\n \"guestList\": \"names\",\n \"showPresentedBy\": true,\n \"background\": {\n \"colors\": [\n \"#0b1c2c\",\n \"#1f6feb\",\n \"#a5d8ff\"\n ]\n },\n \"lineup\": {\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"links\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"media\": [\n {\n \"url\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"title\": \"<string>\"\n },\n \"schedule\": [\n {\n \"content\": \"<string>\",\n \"startTime\": \"2030-01-01T10:10:00.000Z\",\n \"endTime\": \"2030-01-01T10:40:00.000Z\",\n \"timeLabel\": \"<string>\",\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"links\": [\n {\n \"url\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"registrationFields\": [\n {\n \"field\": \"name\",\n \"variant\": \"fullName\",\n \"slug\": \"name\",\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"disableOnPrefill\": true\n }\n ],\n \"hosts\": [\n {\n \"userId\": 123\n }\n ],\n \"liveStreams\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"locations\": [\n {\n \"type\": \"address\",\n \"address\": \"1 Example Street, Berlin\",\n \"label\": \"<string>\",\n \"price\": 1500,\n \"currency\": \"usd\",\n \"capacity\": 50000.5\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cal.com/v2/teams/{teamId}/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Team offsite\",\n \"startTime\": \"2030-01-01T10:00:00.000Z\",\n \"endTime\": \"2030-01-01T11:00:00.000Z\",\n \"timeZone\": \"Europe/Berlin\",\n \"slug\": \"team-offsite-2030\",\n \"description\": \"<string>\",\n \"visibility\": \"PUBLIC\",\n \"capacity\": 50000.5,\n \"waitlistEnabled\": false,\n \"paymentTimeoutMinutes\": 5045,\n \"requiresApproval\": false,\n \"showOrganizerEmail\": true,\n \"guestList\": \"names\",\n \"showPresentedBy\": true,\n \"background\": {\n \"colors\": [\n \"#0b1c2c\",\n \"#1f6feb\",\n \"#a5d8ff\"\n ]\n },\n \"lineup\": {\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"links\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"media\": [\n {\n \"url\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"title\": \"<string>\"\n },\n \"schedule\": [\n {\n \"content\": \"<string>\",\n \"startTime\": \"2030-01-01T10:10:00.000Z\",\n \"endTime\": \"2030-01-01T10:40:00.000Z\",\n \"timeLabel\": \"<string>\",\n \"people\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"links\": [\n {\n \"url\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"registrationFields\": [\n {\n \"field\": \"name\",\n \"variant\": \"fullName\",\n \"slug\": \"name\",\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"disableOnPrefill\": true\n }\n ],\n \"hosts\": [\n {\n \"userId\": 123\n }\n ],\n \"liveStreams\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"locations\": [\n {\n \"type\": \"address\",\n \"address\": \"1 Example Street, Berlin\",\n \"label\": \"<string>\",\n \"price\": 1500,\n \"currency\": \"usd\",\n \"capacity\": 50000.5\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"uuid": "<string>",
"slug": "<string>",
"title": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"checkInOpensAt": "2023-11-07T05:31:56Z",
"checkInClosesAt": "2023-11-07T05:31:56Z",
"timeZone": "<string>",
"visibility": "PUBLIC",
"category": "meetup",
"hidden": true,
"status": "draft",
"locations": [
{
"id": "<string>",
"price": 2500,
"currency": "usd",
"type": "address",
"address": "123 Event Street",
"label": "<string>",
"capacity": 50000.5
}
],
"requiresApproval": true,
"waitlistEnabled": true,
"showOrganizerEmail": true,
"guestList": "hidden",
"showPresentedBy": true,
"liveStreams": [
{
"url": "<string>"
}
],
"registrationFields": [
{
"field": "name",
"slug": "name",
"variant": "fullName",
"disableOnPrefill": true,
"label": "<string>",
"placeholder": "<string>"
}
],
"hosts": [
{
"userId": 123,
"name": "Jane Doe",
"username": "jane",
"avatarUrl": "<string>"
}
],
"description": "<string>",
"publishedAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"coverImageUrl": "<string>",
"paymentTimeoutMinutes": 123,
"confirmedCount": 123,
"theme": "light",
"poster": {
"layout": "date",
"palette": {
"background": "#0b1c2c",
"foreground": "#a5d8ff",
"accent": "#1f6feb"
},
"headline": "<string>",
"seed": 123
},
"lineup": {
"title": "<string>",
"people": [
{
"name": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"links": [
{
"url": "<string>"
}
],
"media": [
{
"url": "<string>",
"label": "<string>"
}
]
}
]
},
"schedule": [
{
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"timeLabel": "<string>",
"content": "<string>",
"people": [
{
"name": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"links": [
{
"url": "<string>"
}
]
}
]
}
],
"background": {
"effect": "aurora",
"colors": [
"<string>"
]
},
"capacity": 100,
"cancellationReason": "<string>",
"userId": 123,
"teamId": 123
}
}Headers
value must be Bearer <token> where <token> is api key prefixed with cal_, managed user access token, or OAuth access token
Path Parameters
The team's uuid (preferred), its short-uuid (Flickr Base58) form, or its numeric id.
Body
application/json
The Event's title.
Required string length:
1 - 255Example:
"Team offsite"
When the Event starts, in ISO 8601 format in UTC timezone. It must not be in the past.
Example:
"2030-01-01T10:00:00.000Z"
When the Event ends, in ISO 8601 format in UTC timezone. It must be after startTime.
Example:
"2030-01-01T11:00:00.000Z"
The IANA time zone the Event's times are shown in.
Example:
"Europe/Berlin"
Public page slug (cal.com/{slug}): 10-100 lowercase letters, digits and hyphens. Generated from the title when omitted.
Example:
"team-offsite-2030"
What the Event is about, shown on its page.
Maximum string length:
5000Once published: PUBLIC is listed on the owner's page, UNLISTED only opens from its link. Defaults to PUBLIC.
Available options:
PUBLIC, UNLISTED The most guests the Event can take. Omit or pass null for unlimited. Ignored once any location has its own capacity: the Event then takes the sum of the location capacities, or is unlimited if any location has none. The waitlist only opens when the Event or the chosen location is full, so it only works when capacity is set on the Event or on a location.
Required range:
1 <= x <= 100000Let guests join a waitlist when the Event is full. The waitlist only opens when the Event or the chosen location is full, so it only works when capacity is set on the Event or on a location.
How many minutes a guest's seat is held while they pay. null uses the default of 10 minutes.
Required range:
10 <= x <= 10080Registrations wait for a host's approval.
Show the organizer's email to guests.
Who guests can see on the Event's page. names lists them, count shows how many, hidden shows neither. Defaults to names.
Available options:
hidden, names, count Show who the Event is presented by.
Default theme of the event page. null follows the visitor's system setting.
Available options:
light, dark Animated background of the event page.
Show child attributes
Show child attributes
Speakers or performers on the event page. Avatars need the Event uuid, so create people without avatarUrl and upload avatars with the person avatar endpoint afterwards.
Show child attributes
Show child attributes
Agenda on the event page. Each item has either a startTime or a timeLabel. Avatars need the Event uuid, so create people without avatarUrl and upload avatars with the person avatar endpoint afterwards.
Maximum array length:
50Show child attributes
Show child attributes
registrationFields
(Default Full Name · object | Default Split Name · object | Default Email · object | Default Location · object | Default Title · object | Default Notes · object | Default Guests · object | Default Reschedule Reason · object | Default Attendee Phone · object | Workflow-added SMS Reminder · object | Workflow-added AI Agent Phone · object | Custom Email · object | Custom Phone · object | Custom Address · object | Custom Short Text · object | Custom Number · object | Custom Long Text · object | Custom Select · object | Custom Multi-Select · object | Custom Multiple Emails · object | Custom Checkbox Group · object | Custom Checkbox · object | Custom Radio Group · object | Custom URL · object)[]
The questions guests answer when they register.
- Default Full Name
- Default Split Name
- Default Email
- Default Location
- Default Title
- Default Notes
- Default Guests
- Default Reschedule Reason
- Default Attendee Phone
- Workflow-added SMS Reminder
- Workflow-added AI Agent Phone
- Custom Email
- Custom Phone
- Custom Address
- Custom Short Text
- Custom Number
- Custom Long Text
- Custom Select
- Custom Multi-Select
- Custom Multiple Emails
- Custom Checkbox Group
- Custom Checkbox
- Custom Radio Group
- Custom URL
Show child attributes
Show child attributes
The Event's hosts. The creator is always a host and always listed first, even when not passed. Personal Events can only have the creator, so passing other ids returns a 400. On team Events every id must be an accepted team member, otherwise it returns a 400.
Show child attributes
Show child attributes
Links where people can watch the event live.
Maximum array length:
5Show child attributes
Show child attributes
What kind of event it is. If not passed, it's guessed from the title.
Available options:
meetup, conference, music, sports Where the Event happens. Links can repeat. An Event can have one address and one conferencing location, either an integration or the organizer's default app.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Was this page helpful?