Skip to navigation

Respond to Event

Beta

Accepts, declines or tentatively accepts an invitation the inbox received by email. Pass the event’s UUID to respond for every date, or a dated ID to respond for one date only.

Only works on email events where the inbox is an attendee; anything else returns 409 calendar_response_invalid. Updates the inbox’s attendee entry and sends calendar.event.responded. With send_reply (default true) the inbox emails the response to the organizer.

Requires the calendar_event_update permission. To make the response conditional, send the current etag in If-Match.

A reply email counts as one send against the organization, pod and inbox send limits, charged before the response is saved; an over-limit request returns 429 rate_limit_exceeded and changes nothing.

Calendar is in private beta in US production (api.agentmail.to). It is unavailable in EU production (api.agentmail.eu). Organizations without access receive a 403.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired
The ID of the inbox.
event_idstringRequired

ID of a calendar event. A one-off or recurring event is addressed by its UUID. One date of a recurring event is addressed by a dated ID, <uuid>_<slot>: <uuid>_t20261015T090000 for a timed date (the original wall-clock start in the event's time zone) or <uuid>_d20261015 for an all-day date. Dated IDs are stable: moving a date keeps its original ID.

Headers

If-MatchstringOptional

The event's or date's current etag. Optional; makes the response conditional; * matches any current version.

Request

This endpoint expects an object.
statusenumRequired
Your response to the invitation.
Allowed values:
commentstringOptional

Comment to include with the response. At most 4,096 UTF-8 bytes, with no control characters other than tab, line feed and carriage return; a longer comment returns 400. It is stored as the inbox's attendee comment.

send_replybooleanOptional

When true (default), emails the response (iCalendar REPLY) to the organizer.

Response

This endpoint returns an object.
eventobject

A calendar event. The same shape is used by every response, list item and webhook. kind says whether it is a one-off event, the definition of a recurring series, or one date of a series.

operation_idstring

ID of the change this request made. The calendar.event.created, calendar.event.updated, calendar.event.deleted or calendar.event.responded webhook for the change carries the same value as its event_id, so you can match webhooks to your own requests.

Errors

400
Validation Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
410
Event Expired Error
412
Precondition Failed Error
413
Payload Too Large Error
429
Rate Limit Error