Company Calendar for Jira v 9.2.x: Events

POST /api/1/event

Creates a new event.

All-day event

{
 "event": {
   "summary": "All-day Rest API event",
   "eventTypeConfigId": "sourceId",
   "userKeys": ["account-id"],
   "allDayStart": "2024-09-29",
   "allDayEnd": "2024-09-29"
 },
 "mode": "add"
}

Timed event

{
 "event": {
   "summary": "Timed Rest API event",
   "eventTypeConfigId": "sourceId",
   "userKeys": ["account-id"],
   "startDate": 1728367200000,
   "endDate": 1728369900000
 },
 "mode": "add"
}

Recurring event

{
  "event": {
    "recurrence": <recurrence rule>, // see specifications  👉️ https://icalendar.org/iCalendar-RFC-5545/3-8-5-3-recurrence-rule.html 
    "eventTypeConfigId": <sourceId>,
    "summary": "Recurrence event",
    "userKeys": [
      "account-id"
    ],
    "allDayStart": "2024-09-02",
    "allDayEnd": "2024-09-02"
  },
  "mode": "add",
  "startDate": "2024-08-26T00:00:00+03:00",
  "endDate": "2024-10-07T00:00:00+03:00"
}

PUT /api/1/event

Updates an existing event

{
 "event": {
   "id": <id>,
   "summary": "Update event",
   "eventTypeConfigId": <evenTypedId>,
   "userKeys": [
     account-id
   ],
   "allDayStart": "2024-08-29",
   "allDayEnd": "2024-08-29"
 },
 "mode": "edit"
}

Updates a recurrent event

{
  "event": {
    "allDayEnd": "2024-09-19",
    "allDayStart": "2024-09-19",
    "eventTypeConfigId": 14817,
    "summary": "Recurrence event",
    "userKeys": [
      "5b0d271581c3df12acf5298e"
    ],
    "parentId": 60707,
    "recurrenceId": "20240904",
     "id": 60709  // Only required for subsequent updates; omit this field when creating the event for the first time
  },
  "mode": "edit",
  "select": "current",
  "startDate": "2024-08-26T00:00:00+03:00",
  "endDate": "2024-10-07T00:00:00+03:00"
}

Response:
200 OK
403 Bad Request

DELETE /api/1/event/{id}

Deletes an event.

DELETE /api/1/event/{id}/recur

This endpoint processes deletion requests for recurring events. Based on the request body, you can delete the entire series, a single occurrence, or exclude a specific instance from the recurrence.

Below is a Confluence-ready version using standard formatting, headings, and code-friendly styling.

Deletion Scenarios

Delete the Entire Recurrence Chain (ALL)

Use this option to remove the full recurring series.

If the event belongs to a recurrence and the recurrence_id is present in the model:
- parentId identifies the main recurring event.
- The entire recurrence chain, including all occurrences, is deleted.

Delete a Single Occurrence (Current Event Only)

Use this option to delete one event instance while keeping the rest of the series.

If the event has a recurrence_id:
- The id in the request URL identifies the specific occurrence to delete.
- parentId in the model refers to the main recurring event.
- Only the selected occurrence is removed; the rest of the chain remains intact.

Delete an Occurrence by Adding an Exception Date

Use this option to exclude an occurrence from the series without deleting the event object.

To remove a specific occurrence using an exception date:
- The model references the same parentId as the main event.
- The id in the URL identifies the affected occurrence.
- During processing, the parentId is overridden by the provided id, ensuring only the targeted occurrence is removed.

Required fields:

mode: "delete"
select: "current"
exdate: YYYY-MM-DD

Delete the Current Event from the Chain (Single Event Deletion)

{
  "event": {
    "eventTypeConfigId":  <sourceId>,
    "recurrenceId":	"20240906",
    "parentId":	<parentId>
  },
  "exdate": "YYYYMMDD",
  "select": "current",
  "startDate": "2024-08-26T00:00:00+03:00",
  "endDate": "2024-10-07T00:00:00+03:00"
}

Delete an Occurrence (Add Exception Date to the Main Chain)

{
  "event": {
    "eventTypeConfigId": <sourceId>
  },
  "select": "current", 
  "exdate": "YYYYMMDD",
  "startDate": "2024-08-26T00:00:00+03:00",
  "endDate": "2024-10-07T00:00:00+03:00"
}