Calendars

Create calendar

Create a new calendar. The calendar name is required, while other properties like color, timezone, and description are optional. If a calendar with the same name already exists, a conflict error will be returned.

post/v1/calendars

Request

Base URL: https://api.forwardemail.net
URL: https://api.forwardemail.net/v1/calendars
Auth: HTTP basic

Request body

namestring required

Calendar name

calendar_idstring

Custom calendar ID (if not provided, will be auto-generated)

descriptionstring

Calendar description

colorstring

Calendar color (hex format, if not provided, will be auto-generated)

timezonestring

Calendar timezone (defaults to user's timezone or UTC)

orderinteger

Calendar display order (defaults to 0)

Response

Calendar created successfully

idstring required

Calendar ID (calendarId from CalDAV)

namestring required

Calendar name

descriptionstring required

Calendar description

colorstring required

Calendar color (hex format)

timezonestring required

Calendar timezone

orderinteger required

Calendar display order

created_atstring date-time required

updated_atstring date-time required

object'calendar' required

Example response

{
  "id": "calendar123",
  "name": "Personal Calendar",
  "description": "My personal calendar",
  "color": "#ff0000",
  "timezone": "America/New_York",
  "order": 0,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "object": "calendar"
}

Changes

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