Sign in
Calendar Events

Updates a calendar event.

  • To set the event to update to recurring, frequency must be set to a value other than NEVER.
    • interval controls how often the event repeats,
      • Example: WEEKLY with an interval = 2, the event repeats every 2 weeks.
      • Default is 1.
    • repeatEndType must be one of:
      • NEVER: Repeats indefinitely. Default value.
      • ON_DATE: Repeats until the specified repeatEndDate.
      • AFTER: Repeats for the specified repeatCount number of occurrences.
    • If repeatEndType = ON_DATE, the repeatEndDate must be provided.
    • If repeatEndType = AFTER, the repeatCount must be provided.
  • If the event to update is recurring, updateAllRecurring must be specified:
    • If updateAllRecurring is true, all future occurrences of the current event are updated.
    • If updateAllRecurring is false, only the current event is updated and future occurrences are not updated.
      • An optional repeatSplitOnDate can be provided and the event is only updated on the specified date and future occurrences are not updated.
      • if the repeatSplitOnDate is not provided, this is set to the event's startTime value.
  • If the event to update is assigned to a group, updateAllGrouped must be specified:
    • If updateAllGrouped is true, all events in the group are updated otherwise only the current event is updated.
  • To assign the event to update, userId or linkedUserIds can be provided, and the event is assigned to those user(s). Otherwise, the event is unassigned.
    • When assigning to a group, i.e. the linkedUserIds is provided, the updateAllGrouped property must be set to true.
post/calendarEvents/{calendarEventId}

Path parameters

calendarEventIdinteger required

Request body

startTimestring date-time required
endTimestring date-time required
eventTitlestring required
descriptionstring
userIdnumber
linkedUserIdsnumber[]
frequency'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY' | 'NEVER'
intervalnumber
repeatEndType'NEVER' | 'ON_DATE' | 'AFTER'
repeatEndDatestring date nullable
repeatCountnumber
repeatSplitOnDatestring date-time nullable
updateAllRecurring'TRUE' | 'FALSE' nullable
updateAllGrouped'TRUE' | 'FALSE' nullable

Example request

{
  "startTime": "2021-01-01T07:00:00.000Z",
  "endTime": "2021-01-01T17:00:00.000Z",
  "repeatEndDate": "2021-01-01",
  "repeatSplitOnDate": "2021-01-01T07:00:00.000Z"
}

Response

Successful Response

resultstring required

Example response

{
  "data": [
    {
      "startTime": "2021-01-01T07:00:00.000Z",
      "endTime": "2021-01-01T17:00:00.000Z"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.