Calendars

Update calendar

Update an existing calendar. You can update any of the calendar properties including name, description, color, timezone, and order. If you change the name to one that already exists, a conflict error will be returned.

put/v1/calendars/{id}

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/calendars/{id}
  • Auth: HTTP basic

Path parameters

idstring required

Calendar ID

Request body

namestring

Calendar name

descriptionstring

Calendar description

colorstring

Calendar color (hex format)

timezonestring

Calendar timezone

orderinteger

Calendar display order

Response

Calendar updated 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.