Skip to main content
POST
calendar.event.respond

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
inbox
string
required

The inbox that was invited.

Required string length: 1 - 320
status
enum<string>
required

Your response to the invitation.

Available options:
accepted,
declined,
tentative
ref
string

The ref of the event, when you have one. Preferred over the invitation email.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
messageId
string

RFC Message-ID of the invitation email, e.g. abc@example.com.

Maximum string length: 998
comment
string

A comment for the organizer.

Required string length: 1 - 4096
sendReply
boolean

Email the reply to the organizer (default). It counts against the daily sending limit and is charged as one send.

version
string

The version a previous read returned: fail instead of overwrite.

Required string length: 1 - 128

Response

The result

status
enum<string>
required

The answer recorded.

Available options:
accepted,
declined,
tentative
responseRecorded
boolean
required

The answer was recorded.