Skip to main content
POST
calendar.update

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
timezone
string
required

IANA time zone, e.g. America/New_York or UTC.

Required string length: 1 - 64
ref
string

The ref an inbox create returned. Preferred over inbox.

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

The inbox address whose calendar to change.

Required string length: 1 - 320
version
string

The version calendar.get returned, to fail instead of overwrite.

Required string length: 1 - 128

Response

The result

inbox
string
required

The inbox address the calendar belongs to.

timezone
string
required

The default time zone now set, e.g. UTC.

eventCount
number

How many events the calendar holds.

version
string

Opaque change marker; pass it as version on calendar.update.