Update an event
PUT
/api/v1/mailbox/calendars/{calendar}/events/{event_id}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
| Name | In | Type | Description |
|---|---|---|---|
calendarrequired | path | string | |
event_idrequired | path | string | |
etag | query | string |
Request body
summarystringrequiredThe event's title.
startstringrequiredISO 8601.
endstringrequiredISO 8601, after
start.timezone_idstring or nullAn IANA time zone, e.g.
Africa/Lagos.all_daybooleanA whole-day event (dates only).
descriptionstring or nullNotes.
locationstring or nullWhere.
rrulestring or nullRepeat rule (RFC 5545), e.g.
FREQ=WEEKLY;BYDAY=MO.reminder_minutesinteger or nullOne reminder, minutes before.
remindersarray<integer> or nullSeveral reminders, minutes before each.
attendeesarray<object> or nullPeople to invite:
emailand optionalname. 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"
}
]
}'const response = await fetch('https://courier.mailyte.com/api/v1/mailbox/calendars/01JBT8XQ2M9WYC3K4F6R7S8T9V/events/01JBT8XQ2M9WYC3K4F6R7S8T9V', {
method: 'PUT',
headers: {
Authorization: 'Bearer MAILBOX_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"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"
}
]
}),
});
const { data } = await response.json();import requests
response = requests.put(
"https://courier.mailyte.com/api/v1/mailbox/calendars/01JBT8XQ2M9WYC3K4F6R7S8T9V/events/01JBT8XQ2M9WYC3K4F6R7S8T9V",
headers={"Authorization": "Bearer MAILBOX_TOKEN"},
json={
"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"
}
]
},
)
data = response.json()["data"]<?php
$response = Http::withToken('MAILBOX_TOKEN')
->put('https://courier.mailyte.com/api/v1/mailbox/calendars/01JBT8XQ2M9WYC3K4F6R7S8T9V/events/01JBT8XQ2M9WYC3K4F6R7S8T9V', [
'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',
],
],
]);
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://courier.mailyte.com/api/v1/mailbox/calendars/01JBT8XQ2M9WYC3K4F6R7S8T9V/events/01JBT8XQ2M9WYC3K4F6R7S8T9V")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer MAILBOX_TOKEN"
request["Content-Type"] = "application/json"
request.body = {
"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"
}
]
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Successful Response
dataobjectidstringetagstringThe new etag.
200
application/json{
"type": "success",
"msg": "Event updated successfully",
"data": {
"id": "8f14e45f.ics",
"etag": "\"d4e5f6\""
}
}Returned inside the standard envelope.
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.` |
422 | Validation Error |
Every status, with what causes it and what to do, is on the error reference.