CancellationEvent

This is an object representing when an appointment was canceled.

actorstringnullablerequired

The actor that initiated the cancellation (user ID or bearer token ID).

cancellation_reason objectnullablerequired

This is an object representing a cancellation reason.

idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^cr_\w{12}$

namestringrequired

The name of the cancellation reason.

objectstringrequired

String representing the object's type.

Possible values: [cancellation_reason]

sort_orderintegerrequired

The sort order of the cancellation reason.

custom_reason_textstringnullablerequired

Custom reason text for the cancellation.

initiated_bystringrequired

The entity that initiated the cancellation.

Possible values: [user, client]

objectstringrequired

Possible values: [cancellation_event]

occurred_atstring<datetime>required

The time at which the cancellation occurred (ISO-8601 format).

sourcestringrequired

The source of the cancellation event.

Possible values: [client_ui, dashboard, api]

CancellationEvent

{
  "actor": null,
  "cancellation_reason": {
    "id": "cr_a1b2c3d4e5f6",
    "name": "Distance too far",
    "object": "cancellation_reason",
    "sort_order": 1
  },
  "custom_reason_text": "I'm sick",
  "initiated_by": "client",
  "object": "cancellation_event",
  "occurred_at": "2023-01-01T03:00:00Z",
  "source": "client_ui"
}