Post
/api/v1/calendar-events.create
Create a new calendar event.
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example 1
{
"startTime": "2025-11-05T07:17:00.000Z",
"endTime": "2025-11-05T07:18:00.000Z",
"subject": "Subject8",
"description": "Description8",
"reminderMinutesBeforeStart": 10
}object
startTime
string Required
Enter the time at which the event starts.
Example2025-11-05T07:17:00.000Z
endTime
string
Enter the time at which the event ends.
Example2025-11-05T07:18:00.000Z
subject
string Required
Enter a subject for the event.
description
string Required
Enter a description for the event.
reminderMinutesBeforeStart
integer
Enter the number of minutes before the event that the reminder should be sent.
Example10
busy
boolean
Enter whether or not you want to set your status as busy.
externalId
string
If you want to use an external event from another calendar, enter the event ID (eid) of the external calendar event.
ExampleNWwwcnU3NmM1NW03dDRtZGdkMWNjNDRmamsgcmFjaGFuYS52aXNhdmFkaXlhQHJvY2tldC5jaGF0
Responses
200
OK
Example 1
{
"id": "690b08674e7e8bcf6985b2d5",
"success": true
}object
id
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string