Create a calendar event
POST/calendar.event.create
Create a calendar event on the host's connected calendar. A Roam meeting link is automatically attached and email notifications are sent to attendees.
The event is written to the first active, writable calendar associated with the host. The host must have a connected calendar provider (e.g. Google, Microsoft).
Recurring events: Provide rrule to create a recurring series. A
timeZone is required for recurring events.
All-day events: Set allDay: true; start and end are interpreted as
dates and normalized to UTC midnight.
Access: Organization and Personal. For Organization tokens, the host email
is required and identifies the calendar owner. For Personal tokens, host
defaults to the authenticated user; if provided it must match the
authenticated user's email.
Required scope: calendar:write
OpenAPI Spec: chat-v1.json
Request
Responses
- 200
- 400
- 401
- 403
- 405
- 500
Calendar event created successfully.
Bad request. Common causes:
- Missing
title,start, orend startorendis not valid RFC3339rruleprovided withouttimeZone- Invalid
timeZone(must be an IANA zone name) - No writable calendar found for the host
- Organization token missing
hostemail - Host email not found in the Roam
Presented invalid authentication credentials.
Forbidden. Personal tokens may only create events for the authenticated user.
An unsupported method was requested.
An internal error occurred.