Create an event

POST/api/v1/mailbox/calendars/{calendar}/events
Requires amailbox token— it acts as one mailbox holder, not as the organization.

Creates an event. Attendees are emailed an invitation.

Errors

Status When
401 No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login.
403 The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required.

Parameters

NameInTypeDescription
calendarrequiredpathstring

Request body

  • summarystringrequired

    The event's title.

  • startstringrequired

    ISO 8601.

  • endstringrequired

    ISO 8601, after start.

  • timezone_idstring or null

    An IANA time zone, e.g. Africa/Lagos.

  • all_dayboolean

    A whole-day event (dates only).

  • descriptionstring or null

    Notes.

  • locationstring or null

    Where.

  • rrulestring or null

    Repeat rule (RFC 5545), e.g. FREQ=WEEKLY;BYDAY=MO.

  • reminder_minutesinteger or null

    One reminder, minutes before.

  • remindersarray<integer> or null

    Several reminders, minutes before each.

  • attendeesarray<object> or null

    People to invite: email and optional name. They are emailed an invitation.

Request

POST/api/v1/mailbox/calendars/{calendar}/events
curl -X POST 'https://courier.mailyte.com/api/v1/mailbox/calendars/01JBT8XQ2M9WYC3K4F6R7S8T9V/events' \
  -H 'Authorization: Bearer MAILBOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "summary": "Quarterly review",
    "start": "2026-10-14T10:00:00+01:00",
    "end": "2026-10-14T11:00:00+01:00",
    "timezone_id": "Africa/Lagos",
    "location": "Board room",
    "reminders": [
      15
    ],
    "attendees": [
      {
        "email": "tunde@example.com",
        "name": "Tunde Bello"
      }
    ]
  }'

Response

Success.

  • dataobject
    • idstring
    • etagstring
200application/json
{
  "type": "success",
  "msg": "Event created successfully",
  "data": {
    "id": "8f14e45f.ics",
    "etag": "\"a1b2c3\""
  }
}

Returned inside the standard envelope.

Errors

StatusWhen
401No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`.
403The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`.
422Validation Error

Every status, with what causes it and what to do, is on the error reference.