Update Calendar Event

Prev Next
Post
/api/v1/calendar-events.update

Update an existing 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
{
  "eventId": "690b08674e7e8bcf6985b2d5",
  "startTime": "2025-11-05T07:17:00.000Z",
  "endTime": "2025-11-05T07:18:00.000Z",
  "subject": "Subject8",
  "description": "Description8",
  "reminderMinutesBeforeStart": 10
}
object
eventId
string Required

Enter the event ID that you want to update.

startTime
string Required

Enter the time at which the event starts.

endTime
string

Enter the time at which the event ends.

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.

busy
boolean

Enter whether or not you want to set your status as busy.

Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'eventId' [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