Skip to Content
POST
/api/v1/identities/{identityId}/calendars/invitations/respond

Files an emailed calendar invitation to the default calendar and submits the user's RSVP response (ACCEPT, DECLINE, TENTATIVE) to the organizer.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.

oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.

oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.

Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].

Path Parameters

identityId*string

Identity ULID identifier

Request Body

application/json
  1. body
ics?string

Inline form: the raw text/calendar part from the message

Length1 <= length <= 262144
messageId?string

Reference form: a message in THIS mailbox carrying the invitation

Length1 <= length <= 64
partstat*string

RFC 5545 PARTSTAT to record for the caller

Value in"ACCEPTED""DECLINED""TENTATIVE""NEEDS-ACTION"
section?string

Reference form, optional: the part's section as reported by …/messages/{id}/invitation. Omitted, the server picks the message's scheduling part itself

Match^[0-9]+(\.[0-9]+)*$
Lengthlength <= 64

Response Body

Recorded. filed says whether a copy had to be created; organizerUpdated / replySent report how the organizer was told, exactly as the collection-scoped RSVP does

application/json
  1. response
calendarId*string

Calendar collection ULID holding the event

etag*string

Updated ETag of the calendar object

filed*boolean

True if the event was newly added to the calendar

href*string

DAV resource path of the event

myAddress*string

Recipient email address for which this RSVP was recorded

organizerUpdated*boolean

True if local organizer event copy was updated directly

partstat*string

Recorded participation status (ACCEPTED, DECLINED, TENTATIVE)

Value in"ACCEPTED""DECLINED""TENTATIVE""NEEDS-ACTION"
replySent*boolean

True if email reply was sent to remote organizer

summary*|

Event title/summary, or null

Example Request
curl -X POST 'https://api.open.email/api/v1/identities/string/calendars/invitations/respond' \
  -H 'Content-Type: application/json' \
  -d '{
  "partstat": "ACCEPTED"
}'
Example Response
{
  "calendarId": "string",
  "etag": "string",
  "filed": true,
  "href": "string",
  "myAddress": "string",
  "organizerUpdated": true,
  "partstat": "ACCEPTED",
  "replySent": true,
  "summary": "string"
}