Update an event

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

Replaces the event. Send the etag you read (as a query parameter) so a change made elsewhere is not overwritten. Attendees are told of the change.

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.
404 Event not found.
409 This event changed elsewhere. Reload and try again.

Parameters

NameInTypeDescription
calendarrequiredpathstring
event_idrequiredpathstring
etagquerystring

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

PUT/api/v1/mailbox/calendars/{calendar}/events/{event_id}
curl -X PUT 'https://courier.mailyte.com/api/v1/mailbox/calendars/01JBT8XQ2M9WYC3K4F6R7S8T9V/events/01JBT8XQ2M9WYC3K4F6R7S8T9V' \
  -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

Successful Response

  • dataobject
    • idstring
    • etagstring

      The new etag.

200application/json
{
  "type": "success",
  "msg": "Event updated successfully",
  "data": {
    "id": "8f14e45f.ics",
    "etag": "\"d4e5f6\""
  }
}

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`.
404Event not found.
409`This event changed elsewhere. Reload and try again.`
422Validation Error

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