Skip to Content

RSVP to calendar invitation.

Records an attendee's participation status (ACCEPTED, DECLINED, TENTATIVE) and notifies the meeting organizer via direct update or iTIP reply message.

openemail.calendarObjects.respond(
  identityId: string,
  calendarId: string,
  href: string,
  body: CalendarObjectsRespondBody,
  options?: CallOptions,
): ApiPromise<CalendarObjectsRespondResult>

It calls POST /identities/{identityId}/calendars/{calendarId}/objects/{href}/respond: RSVP to calendar invitation in the API reference.

Example

const result = await openemail.calendarObjects.respond(identityId, calendarId, href, { partstat: 'ACCEPTED' })

Arguments

ArgumentTypeDescription
identityIdstringIdentity ULID identifier. The path's {identityId}.
calendarIdstringCollection ULID or its name slug. The path's {calendarId}.
hrefstringResource href slug. The path's {href}.
bodyCalendarObjectsRespondBodyThe request's body.

Options

It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, CalendarObjectsRespondResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
403not_attendee: the caller is not on this event
404No such object, collection, or mailbox
409conflict: the copy changed concurrently under the reply; retry
413too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing
503temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

CalendarObjectsRespondBody

/** The body of `calendarObjects.respond`. */
type CalendarObjectsRespondBody = {
  /** RFC 5545 PARTSTAT to record for the caller */
  partstat: ('ACCEPTED' | 'DECLINED' | 'TENTATIVE' | 'NEEDS-ACTION')
}

CalendarObjectsRespondResult

/** What `calendarObjects.respond` answers. */
type CalendarObjectsRespondResult = {
  etag: string
  organizerUpdated: boolean
  partstat: ('ACCEPTED' | 'DECLINED' | 'TENTATIVE' | 'NEEDS-ACTION')
  /** Present when the answer was recorded but the organizer could not be told: a sharee answered on the calendar owner's behalf and the organizer is remote, so a reply would have been sent as the owner. The RSVP itself succeeded. */
  refusal?: 'delegate'
  replySent: boolean
}