Skip to main content
POST
calendar.calendar.create

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 owned connected mailbox address.

Required string length: 1 - 320
name
string
required

Calendar name.

Required string length: 1 - 256
description
string

Calendar description.

Required string length: 1 - 8192
location
string

Calendar location.

Required string length: 1 - 255
metadata
object
timezone
string

IANA time zone, such as UTC.

Required string length: 1 - 64

Response

The result

name
string
required

Calendar name.

description
string

Calendar description.

location
string

Calendar location.

timezone
string

IANA time zone, such as UTC.

isPrimary
boolean

Whether this is the primary calendar.

metadata
object
textColor
string
backgroundColor
string
readOnly
boolean

Whether this calendar is read only.

ref
string

Reference to what this call created. Pass it as ref to calendar.calendar.get.