Post
/api/v1/calendar-events.import
Use this endpoint to import an exteral 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
{
"externalId": "NWwwcnU3NmM1NW03dDRtZGdkMWNjNDRmamsgcmFjaGFuYS52aXNhdmFkaXlhQHJvY2tldC5jaGF0",
"startTime": "2025-11-05T07:17:00.000Z",
"endTime": "2025-11-05T07:18:00.000Z",
"subject": "Subject8",
"description": "Description8",
"reminderMinutesBeforeStart": 10,
"busy": true
}object
externalId
string Required
Enter the event ID (eid) of the external calendar event.
startTime
string Required
Enter the time at which the event begins.
endTime
string
Enter the time at which the event ends.
subject
string Required
Enter the event subject.
description
string Required
Enter the event description.
reminderMinutesBeforeStart
integer
Enter the number of minutes before the event that the reminder must be sent.
busy
boolean
Enter whether or not you want to set your status as busy.
Responses
200
OK
Example 1
{
"id": "690c2b2d4e7e8bcf6985b3d8",
"success": true
}object
id
string
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'externalId' [invalid-params]",
"errorType": "invalid-params"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string