/api/v1/calendar-eventsCreate calendar event
Create a new calendar event
Authentication
Send your API key in the x-api-key header.
Request body
requiredCalendar event data
PublicApiCreateCalendarEventDto
calendarIdrequiredstring
Calendar ID this event belongs to
titlerequiredstring
Title of the calendar event
descriptionstring
Description of the calendar event
startDateTimerequiredstring (date-time)
Date and time when the event starts
endDateTimerequiredstring (date-time)
Date and time when the event ends
locationstring
Location of the event
statusstring
Status of the calendar event
completedconfirmedtentativecancelledvisibilitystring
Visibility of the calendar event
defaultpublicprivateorganizerEmailstring
Email of the event organizer
organizerNamestring
Name of the event organizer
busyboolean
Whether the event is marked as busy
readOnlyboolean
Whether the event is read-only
hideParticipantsboolean
Whether to hide participants
durationnumber
Duration of the event in seconds
recurrencearray<string>
Recurrence rules for the event
participantsarray<PublicApiCalendarEventParticipantDto>
Event participants
meetingUrlstring
Meeting URL
metadataobject
Additional metadata for the event
Example request
{
"calendarId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
"title": "Team Meeting",
"description": "Weekly team standup meeting",
"startDateTime": "2024-07-15T10:00:00.000Z",
"endDateTime": "2024-07-15T11:00:00.000Z",
"location": "Conference Room A",
"status": "confirmed",
"visibility": "default",
"organizerEmail": "organizer@example.com",
"organizerName": "John Doe",
"busy": true,
"readOnly": false,
"hideParticipants": false,
"duration": 3600,
"recurrence": [
"FREQ=WEEKLY;BYDAY=MO"
],
"participants": [
{
"email": "john.doe@example.com",
"name": "John Doe",
"status": "yes"
}
],
"meetingUrl": "https://zoom.us/j/91288944390?pwd=1234567890",
"metadata": {
"customField": "value"
}
}
Responses
PublicApiCreateCalendarEventResponseDto
statusCoderequirednumber
countrequirednumber
errorrequiredstring
datarequiredPublicApiCalendarEventDto
Example response
{
"statusCode": 200,
"count": 0,
"error": null,
"data": {
"id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
"calendarId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
"title": "Team Meeting",
"description": "Weekly team standup meeting",
"startDateTime": "2024-07-15T10:00:00.000Z",
"endDateTime": "2024-07-15T11:00:00.000Z",
"location": "Conference Room A",
"status": "confirmed",
"visibility": "default",
"organizerEmail": "organizer@example.com",
"organizerName": "John Doe",
"busy": true,
"readOnly": false,
"hideParticipants": false,
"htmlLink": "https://calendar.google.com/event?eid=...",
"iCalUID": "event123@google.com",
"nylasId": "nylas_event_123",
"masterEventId": "master_event_123",
"duration": 3600,
"recurrence": [
"FREQ=WEEKLY;BYDAY=MO"
],
"participants": [
{
"email": "john.doe@example.com",
"name": "John Doe",
"status": "yes"
}
],
"conferencing": {
"provider": "Zoom Meeting",
"details": {
"url": "https://meet.google.com/abc123def456"
}
},
"metadata": {
"customField": "value"
},
"createdAt": "2024-07-15T09:00:00.000Z",
"updatedAt": "2024-07-15T09:30:00.000Z"
}
}