Calendar

Send the event to its attendees as an invitation

Sends a real iCalendar invitation (METHOD:REQUEST) from the inbox to every attendee, through the normal send path (quota, guardrails and suppression apply; needs messages.send). The recipient sees Accept/Decline and the event lands on their calendar. The event keeps its ical_uid, so calling this again after a PATCH sends an update with a higher SEQUENCE that replaces the earlier entry rather than duplicating it. When the event's status is cancelled the message goes out as METHOD:CANCEL instead. Marks the event source: sent and links the message. The inbox must be the organizer. SDK: calendar.invite.

post/v1/inboxes/{inbox_id}/calendar/events/{event_id}/invite

Request

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

Path parameters

inbox_idstring required
event_idstring required

Request body

subjectstring

Defaults to "Invitation: {title}", "Updated invitation: {title}" or "Cancelled: {title}".

text_bodystring

Covering text. Defaults to a line naming the event, when and where.

html_bodystring
in_reply_tostring

A message_id to thread the invitation under.

Response

Sent.

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 sent message.

invited_atstring nullable
created_atstring
updated_atstring
method'REQUEST' | 'CANCEL'

CANCEL when the event's status is cancelled; REQUEST otherwise.

sent_tostring[]

Changes

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