Skip to main content
POST
calendar.event.delete

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 inbox whose event to delete.

Required string length: 1 - 320
ref
string

The ref calendar.event.create returned. Preferred over the invitation email.

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

RFC Message-ID of the invitation email the event came from.

Maximum string length: 998
mode
enum<string>

For a date of a series: single (default) cancels that date, future cancels it and every later one, ending the series.

Available options:
single,
future
sendInvites
boolean

Email one cancellation per attendee. Each counts against the daily send limit and is charged per attendee. Only events your inbox organizes can send.

version
string

The version a previous read or write returned: fail instead of overwrite.

Required string length: 1 - 128

Response

The result

deleted
boolean
required

The event was deleted, or the date cancelled.