Create a new event in the selected calendar
POST /api/2.0/calendar/{calendarId}/event
Request
Creates a new event in the selected calendar with the parameters specified in the request.
Authorization
An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization
.
Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436
.
Headers
- Accept
enum of string
Can be one of:
application/json
.- Content-Type
enum of string
Can be one of:
application/json
.
Path
- calendarId
integer
int32 Calendar ID
Body
- name
string
Event name
- description
string
Event description
- startDate
string
Event start date
- endDate
string
Event end date
- repeatType
string
Event repeat type (RRULE string in the iCal format)
- alertType
integer
Event notification type
- isAllDayLong
boolean
Event duration type: all day long or not
- sharingOptions
array of object
Event sharing access parameters
Examples
POST /api/2.0/calendar/%7BcalendarId%7D/event HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request POST \
--url https://example.com/api/2.0/calendar/%7BcalendarId%7D/event \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
List of events
- Id
string
- Uid
string
- CalendarId
string
- Name
string
- Description
string
- AllDayLong
boolean
- Start
string
- End
string
- RepeatRule
string
- Alert
object
- Type
integer
int32
- IsShared
boolean
- CanUnsubscribe
boolean
- IsEditable
boolean
- Permissions
object
- UserParams
array of object
- Id
string
uuid - Name
string
- Owner
object
- Id
string
uuid - Name
string
- Status
enum of integer
int32 [0 - Tentative, 1 - Confirmed, 2 - Cancelled]
Can be one of:
Tentative
,Confirmed
,Cancelled
.- HasAttachments
boolean
401
Unauthorized