> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. # Respond to Event POST https://api.agentmail.to/v0/inboxes/{inbox_id}/calendar/events/{event_id}/respond Content-Type: application/json 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`. Reference: https://docs.agentmail.to/api-reference/inboxes/calendar/respond-to-event ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://api.agentmail.to` (prod, default) - `https://x402.api.agentmail.to` (prod-x402) - `https://mpp.api.agentmail.to` (prod-mpp) - `https://api.agentmail.eu` (eu-prod) ## Request ### Path parameters - `inbox_id` (string, required) — The ID of the inbox. - `event_id` (string, required) — 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, `_`: `_t20261015T090000` for a timed date (the original wall-clock start in the event's time zone) or `_d20261015` for an all-day date. Dated IDs are stable: moving a date keeps its original ID. ### Headers - `If-Match` (string, optional) — The event's or date's current `etag`. Optional; makes the response conditional; `*` matches any current version. ### Body (application/json) This endpoint expects an object. - `status` (enum, required) — Your response to the invitation. - Allowed values: `accepted`, `declined`, `tentative` - `comment` (string, optional) — 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_reply` (boolean, optional) — When `true` (default), emails the response (iCalendar `REPLY`) to the organizer. ## Response ### 200 - `event` (CalendarEvent, required) — 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_id` (string, required) — 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 - `name` (string, required) — Name of error. - `errors` (any, required) — Validation errors. Each entry has a path and a message identifying the invalid field. - `code` (string, optional) — Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text. - `message` (string, optional) — Error message. - `fix` (string, optional) — The concrete next action that resolves the error. - `docs` (string, optional) — Link to the error reference entry for this code. ### 403 Forbidden Error The organization does not have calendar access (calendar is in private beta), or the API key lacks the required calendar permission. - `name` (string, required) — Name of error. - `message` (string, required) — Error message. - `code` (string, optional) — Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text. - `fix` (string, optional) — The concrete next action that resolves the error. - `docs` (string, optional) — Link to the error reference entry for this code. ### 404 Not Found Error - `name` (string, required) — Name of error. - `message` (string, required) — Error message. - `code` (string, optional) — Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text. - `fix` (string, optional) — The concrete next action that resolves the error. - `docs` (string, optional) — Link to the error reference entry for this code. ### 409 Conflict Error - `name` (string, required) — Name of error. - `message` (string, required) — Error message. - `code` (string, optional) — Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text. - `fix` (string, optional) — The concrete next action that resolves the error. - `docs` (string, optional) — Link to the error reference entry for this code. ### 410 Event Expired Error The event's date is outside the retained history window and can no longer be read or changed. - `name` (string, required) — Name of error. - `message` (string, required) — Error message. - `code` (string, optional) — Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text. - `fix` (string, optional) — The concrete next action that resolves the error. - `docs` (string, optional) — Link to the error reference entry for this code. ### 412 Precondition Failed Error The resource changed since the `If-Match` value was read. Fetch it again, reapply the change, and retry with the new `etag`. - `name` (string, required) — Name of error. - `message` (string, required) — Error message. - `code` (string, optional) — Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text. - `current_revision` (integer, optional) — The resource's current revision. - `fix` (string, optional) — The concrete next action that resolves the error. - `docs` (string, optional) — Link to the error reference entry for this code. ### 413 Payload Too Large Error The request body is too large (8 KB for calendar settings, 128 KB for events). - `name` (string, required) — Name of error. - `message` (string, required) — Error message. - `code` (string, optional) — Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text. - `fix` (string, optional) — The concrete next action that resolves the error. - `docs` (string, optional) — Link to the error reference entry for this code. ### 429 Rate Limit Error Too many requests, or the invitation emails this request would send exceed an organization, pod or inbox send limit. Nothing was changed. Honor the `Retry-After` header when present. - `name` (string, required) — Name of error. - `message` (string, required) — Error message. - `code` (string, optional) — Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text. - `fix` (string, optional) — The concrete next action that resolves the error. - `docs` (string, optional) — Link to the error reference entry for this code. ## Types ### CalendarEvent 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. - `event_id` (string, required) — 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, `_`: `_t20261015T090000` for a timed date (the original wall-clock start in the event's time zone) or `_d20261015` for an all-day date. Dated IDs are stable: moving a date keeps its original ID. - `kind` (enum, required) — What the event object represents. - `single`: a one-off event, addressed by its UUID. - `series`: the definition of a recurring event, addressed by its UUID. It carries `recurrence`; `start` and `end` describe its first date. - `instance`: one date of a recurring event, addressed by its dated ID. It carries `series_id`, `original_start` and `is_exception`. - Allowed values: `single`, `series`, `instance` - `title` (string, required) — Title of the event. - `status` (enum, required) — Status of the event. A `cancelled` event or date stays readable but sends no `calendar.event.starting` or `calendar.event.ending` webhooks (cancelling a date that is already running still sends its `calendar.event.ending`). A date cancelled by deleting its dated ID is removed from the series instead, so reading it can return `404` or `410`. - Allowed values: `confirmed`, `tentative`, `cancelled` - `all_day` (boolean, required) — Whether this is an all-day event. - `start` (string, required) — Local start time in `timezone`. For all-day events, the first day. - `end` (string, required) — Local end time in `timezone`. For all-day events, the last day (inclusive). - `timezone` (string, required) — Canonical IANA time zone name, for example `America/New_York`, `Europe/London` or `UTC`. Abbreviations such as `PST`, Windows names such as `Pacific Standard Time`, and spellings that differ from the canonical name are rejected. - `duration_mode` (enum, required) — How the event's length is kept when a date crosses a daylight-saving change. - `exact`: the event lasts the same elapsed time. Default for one-off timed events. - `nominal`: the event keeps its wall-clock end time (a 09:00 to 10:00 meeting stays 09:00 to 10:00 local time). Default for recurring timed events. All-day events are always `nominal`. - Allowed values: `nominal`, `exact` - `duration_value` (integer, required) — Length of the event, in milliseconds for timed events and in days for all-day events. - `start_at` (datetime, required) — Start as a UTC instant. This is when `calendar.event.starting` is due. - `end_at` (datetime, required) — End as a UTC instant. This is when `calendar.event.ending` is due. - `attendee_count` (integer, required) — Number of attendees. - `uid` (string, required) — iCalendar UID of the event. Invitations about this event carry the same UID. - `sequence` (integer, required) — iCalendar SEQUENCE number. It increases when a change to a one-off or series event affects what attendees see (time, status, title, description, location, recurrence or attendees). A change to a dated event increases it only when the change is sent with `send_invites`. - `source` (enum, required) — Where the event came from. `api` events were created through this API and the inbox is their organizer. `email` events were created from a calendar invitation (iMIP) received by the inbox; their organizer is the sender of the invitation. - Allowed values: `api`, `email` - `created_at` (datetime, required) — Time at which the event (or, for a date, the definition governing it) was created. - `updated_at` (datetime, required) — Time at which the event (or, for a date, the definition governing it) was last updated. - `series_id` (string, optional) — For `instance` events, the UUID of the series this date belongs to. - `original_start` (string, optional) — For `instance` events, the date's start as the series rule generated it, before any edit. - `original_start_at` (datetime, optional) — For `instance` events, `original_start` as a UTC instant. - `is_exception` (boolean, optional) — For `instance` events, `true` when this date was edited or moved, individually or by a `mode=future` change. - `description` (string, optional) — Description of the event. Omitted from agenda and instance list items. - `location` (string, optional) — Location of the event. - `metadata` (any, optional) — Your own JSON value for the event, usually an object. Never sent to attendees. Omitted from agenda and instance list items. - `recurrence` (Recurrence, optional) — For `series` events, the recurrence. - `attendees` (list of Attendee, optional) — Attendees of the event. Omitted from agenda and instance list items; `attendee_count` is always present. - `organizer_email` (string, optional) — Email address of the organizer. For `api` events, the inbox. - `origin_message_id` (string, optional) — For `email` events, the ID of the message whose invitation last created or updated the event. - `resource_revision` (integer, optional) — Present on `single` and `series` events, except agenda items and `calendar.event.starting` and `calendar.event.ending` payloads, which omit it. - `etag` (string, optional) — The event's or date's current version, also sent as the `ETag` response header. Send it in `If-Match` to make an update, delete or response conditional. Present on Get, Create, Update, Delete and Respond responses; list items and webhooks omit it. Treat it as opaque: a dated event's `etag` (`"occ-..."`) is not derived from `resource_revision`. ### Recurrence The recurrence of a series, as stored. - `rule` (string, required) — Normalized RRULE body, without the `RRULE:` prefix. - `exdates` (list of string, optional) - `rdates` (list of RecurrenceDate, optional) - `truncate_before` (string, optional) — Set when the series was ended with a `mode=future` delete: no date starting at or after this wall-clock time occurs. ### Attendee - `email` (string, required) — Email address of the attendee. Stored in lowercase. Must be unique within the event. - `name` (string, optional) — Display name of the attendee. At most 256 characters. - `status` (enum, optional) — Response status. Defaults to `needs_action`. - Allowed values: `needs_action`, `accepted`, `declined`, `tentative` - `role` (enum, optional) — Defaults to `required`. - Allowed values: `required`, `optional` - `comment` (string, optional) — Comment the attendee sent with their response. At most 4,096 UTF-8 bytes; on create or update, a longer comment is dropped rather than rejected. - `responded_at` (datetime, optional) — Time at which the attendee last responded. ### RecurrenceDate A wall-clock date or date-time, or (timed events only) a period. ### RecurrencePeriod An extra date (RDATE) given as a period. Specify exactly one of `end` or `duration`. - `start` (string, required) — A local wall-clock time without an offset, interpreted in the event's `timezone`. Timed events use `YYYY-MM-DDTHH:mm:ss` (for example `2026-10-15T09:00:00`). All-day events use `YYYY-MM-DD`. Years must be between 1900 and 9999. - `end` (string, optional) — A local wall-clock time without an offset, interpreted in the event's `timezone`. Timed events use `YYYY-MM-DDTHH:mm:ss` (for example `2026-10-15T09:00:00`). All-day events use `YYYY-MM-DD`. Years must be between 1900 and 9999. - `duration` (string, optional) — ISO 8601 duration, for example `PT30M`. ## Examples **Request** ```json { "status": "accepted", "comment": "See you there." } ``` **Response** ```json { "event": { "event_id": "a1d5c7e9-2b4f-4c6a-9e8d-3f7b1c5a9d20", "kind": "single", "title": "Quarterly review", "status": "confirmed", "all_day": false, "start": "2026-10-20T11:00:00", "end": "2026-10-20T12:00:00", "timezone": "Europe/London", "duration_mode": "exact", "duration_value": 3600000, "start_at": "2026-10-20T10:00:00Z", "end_at": "2026-10-20T11:00:00Z", "attendee_count": 2, "uid": "4q2m9x8k1v7c@google.com", "sequence": 0, "source": "email", "created_at": "2026-10-02T07:58:00Z", "updated_at": "2026-10-02T08:05:00Z", "description": "Agenda attached.", "attendees": [ { "email": "jane@acme.com", "name": "Jane Doe", "status": "accepted", "role": "required" }, { "email": "scheduler@agentmail.to", "status": "accepted", "role": "required", "comment": "See you there.", "responded_at": "2026-10-02T08:05:00Z" } ], "organizer_email": "jane@acme.com", "origin_message_id": "", "resource_revision": 1, "etag": "\"rv-1\"" }, "operation_id": "0d6f1e2a-9c3b-4d5e-8f7a-6b1c2d3e4f50" } ``` **SDK Code** ```python import requests url = "https://api.agentmail.to/v0/inboxes/scheduler%40agentmail.to/calendar/events/a1d5c7e9-2b4f-4c6a-9e8d-3f7b1c5a9d20/respond" payload = { "status": "accepted", "comment": "See you there." } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.agentmail.to/v0/inboxes/scheduler%40agentmail.to/calendar/events/a1d5c7e9-2b4f-4c6a-9e8d-3f7b1c5a9d20/respond'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"status":"accepted","comment":"See you there."}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.agentmail.to/v0/inboxes/scheduler%40agentmail.to/calendar/events/a1d5c7e9-2b4f-4c6a-9e8d-3f7b1c5a9d20/respond" payload := strings.NewReader("{\n \"status\": \"accepted\",\n \"comment\": \"See you there.\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.agentmail.to/v0/inboxes/scheduler%40agentmail.to/calendar/events/a1d5c7e9-2b4f-4c6a-9e8d-3f7b1c5a9d20/respond") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"status\": \"accepted\",\n \"comment\": \"See you there.\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.agentmail.to/v0/inboxes/scheduler%40agentmail.to/calendar/events/a1d5c7e9-2b4f-4c6a-9e8d-3f7b1c5a9d20/respond") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"status\": \"accepted\",\n \"comment\": \"See you there.\"\n}") .asString(); ``` ```php request('POST', 'https://api.agentmail.to/v0/inboxes/scheduler%40agentmail.to/calendar/events/a1d5c7e9-2b4f-4c6a-9e8d-3f7b1c5a9d20/respond', [ 'body' => '{ "status": "accepted", "comment": "See you there." }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.agentmail.to/v0/inboxes/scheduler%40agentmail.to/calendar/events/a1d5c7e9-2b4f-4c6a-9e8d-3f7b1c5a9d20/respond"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"status\": \"accepted\",\n \"comment\": \"See you there.\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "status": "accepted", "comment": "See you there." ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentmail.to/v0/inboxes/scheduler%40agentmail.to/calendar/events/a1d5c7e9-2b4f-4c6a-9e8d-3f7b1c5a9d20/respond")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```