Skip to main content
PATCH
Change 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.

Path Parameters

id
string<uuid>
required

Public id of the member's own entry or of a company event visible to them.

Body

application/json

Fields to change; others stay as they are.

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

Must not precede starts_at.

all_day
boolean

Defaults to false.

time_zone
string

An IANA or Rails time zone name.

Required string length: 1 - 255
Pattern: \S
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 changed entry.

One calendar entry.

status
integer
required
data
object
required

One calendar entry.

meta
object
required

Envelope metadata present on every response.