Skip to main content
PATCH
Update a non-sending event

Authorizations

Authorization
string
header
required

Qubrics API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Scopes

calendar.write

Create calendars and create, edit and delete events in this mailbox

Headers

If-Match
string
required

ETag from the most recent event GET. Wildcards are rejected.

Minimum string length: 1

Path Parameters

event_id
string
required

Event ID in the selected mailbox.

Required string length: 1 - 4096
Pattern: ^[A-Za-z0-9_-]+$

Query Parameters

mailbox_id
string

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Body

application/json
description
string | null

Plain text event details. Set null to clear.

Maximum string length: 20000
duration
string

Event duration expressed as days, hours, minutes or seconds.

Maximum string length: 80
Pattern: ^P(?=\d+D|T\d)(?:\d+D)?(?:T(?=\d)(?:\d+H)?(?:\d+M)?(?:\d+(?:\.\d{1,9})?S)?)?$
Example:

"PT1H"

start
string

Local start date and time without an offset, interpreted in time_zone.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$
Example:

"2026-11-02T10:00:00"

time_zone
string

Time zone for local event times.

Required string length: 1 - 100
Example:

"Australia/Melbourne"

title
string

Event title.

Maximum string length: 1000
Example:

"Appointment"

Response

Update acknowledged. Fetch the event for its current version.

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required