Skip to main content
POST
Add a personal calendar event

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Body

application/json

A new personal entry.

title
string
required
Required string length: 1 - 255
Pattern: \S
starts_at
string<date-time>
required
ends_at
string<date-time>
required

Must not precede starts_at.

time_zone
string
required

An IANA or Rails time zone name.

Required string length: 1 - 255
Pattern: \S
description
string | null
all_day
boolean

Defaults to false.

location
object | null

Where the entry happens; null clears it.

contact_id
string<uuid> | null

A contact the member owns; null unlinks it. Any other id is 422.

Response

The created entry.

One calendar entry.

status
integer
required
data
object
required

One calendar entry.

meta
object
required

Envelope metadata present on every response.