v1

latestOpenAPI 3.0.02026-08-0645062.8 KB

Create a calendar event

Create a new calendar event based on the provided payload.

post/events

Request body

tenantIdnumber
userIdstring
connectionIdstring
calendarIdstring
subjectstring
userAttendeesstring[]
leadAttendeesstring[]
contactAttendeesstring[]
otherAttendeesstring[]
isOnlineMeetingboolean
onlineMeetingProviderstring
locationstring
sendUpdatesstring
entityBaseIdstring
entityTypeIdnumber
isAllDayboolean

Example request

{
  "tenantId": 1,
  "userId": "user-123",
  "connectionId": "conn-123",
  "calendarId": "calendar-123",
  "subject": "Meeting with team",
  "body": {
    "contentType": "text/plain",
    "content": "Discuss project updates"
  },
  "start": {
    "dateTime": "2023-01-01T10:00:00Z",
    "timeZone": "UTC"
  },
  "end": {
    "dateTime": "2023-01-01T11:00:00Z",
    "timeZone": "UTC"
  },
  "userAttendees": [
    "user@example.com"
  ],
  "leadAttendees": [
    "lead@example.com"
  ],
  "contactAttendees": [
    "contact@example.com"
  ],
  "otherAttendees": [
    "other@example.com"
  ],
  "isOnlineMeeting": true,
  "onlineMeetingProvider": "Zoom",
  "location": "Conference Room",
  "sendUpdates": "all",
  "entityBaseId": "entity-123",
  "entityTypeId": 1
}

Response

Calendar event created successfully

messagestring
eventIdstring

Example response

{
  "message": "Calendar event created successfully",
  "eventId": "event-123"
}