Calendar

Update a calendar event

Partial update; fields left out keep their values, and a moved start keeps the event's length unless end or duration_minutes is given. Once the event has been sent as an invitation, every update raises sequence, so the next invite goes out as a revision that calendar clients apply to the existing entry. Setting status to cancelled emits calendar.event.cancelled; anything else emits calendar.event.updated. SDK: calendar.update.

patch/v1/inboxes/{inbox_id}/calendar/events/{event_id}

Request

  • Base URL: https://api.deadsimple.email
  • URL: https://api.deadsimple.email/v1/inboxes/{inbox_id}/calendar/events/{event_id}
  • Auth: HTTP bearer

Path parameters

inbox_idstring required
event_idstring required

Request body

titlestring
startstring

"2026-09-15T15:00:00Z", "2026-09-15T15:00:00-04:00", "2026-09-15T15:00:00" plus timezone, or "2026-09-15".

endstring

Omit to use duration_minutes (default 30). On PATCH, a moved start keeps the event's length.

duration_minutesinteger
timezonestring

IANA zone for a local start/end with no offset, e.g. America/New_York. Also sets X-WR-TIMEZONE on the feed.

all_dayboolean
descriptionstring
locationstring
status'confirmed' | 'tentative' | 'cancelled'
ical_uidstring

Create only. Supply your own iCalendar UID; otherwise one is generated as {hex}@deadsimple.email.

sequenceinteger

iCalendar SEQUENCE. Managed for you; set it only to take over from a calendar system that already sent this event.

Response

The updated event.

event_idstring
inbox_idstring
workspace_idstring nullable
ical_uidstring

Stable across updates. What an update, cancellation or reply is matched on, on both ends.

titlestring
descriptionstring
locationstring
start_atstring

ISO 8601 UTC, e.g. 2026-09-15T19:00:00Z

end_atstring

ISO 8601 UTC. Exclusive for all-day events.

timezonestring
all_dayboolean
status'confirmed' | 'tentative' | 'cancelled'
source'api' | 'sent' | 'inbound'

api = created here; sent = created here and sent as an invitation; inbound = arrived by email.

sequenceinteger
message_idstring nullable

The invitation we sent, or the inbound message that last created, updated or cancelled the event.

invited_atstring nullable
created_atstring
updated_atstring

Changes

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