Objects - Charter Docs

Model tree

CalendarsEventsAddBodyExternal

CalendarsEventsAddBodyLuma

LocationGoogle

LocationLookup

EventDefaults

EventDefaultsFeedbackEmail

CalendarsEventsAddBodyExternal

Declared inline in the spec: CalendarsEventsAdd.body_external.

Field	Type	Description
`platform` *	`string`	—
`submissionMode`	`"auto" \| "pending"`	`auto` approves the event immediately. `pending` keeps the event pending for calendar admin approval. Defaults to `auto` when omitted.
`url` *	`string`	—
`name` *	`string`	—
`startAt` *	`string`	ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z
`durationInterval` *	`string`	ISO 8601 Duration. For example, PT2H
`timezone` *	`string`	IANA Timezone, e.g. America/New_York. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
`geoAddressJson`	GeoAddressJsonManual \| GeoAddressJsonGoogle \| GeoAddressJsonLookup	—
`host`	`string`	—

CalendarsEventsAddBodyLuma

Declared inline in the spec: CalendarsEventsAdd.body_luma.

Field	Type	Description
`platform` *	`string`	—
`submissionMode`	`"auto" \| "pending"`	`auto` approves the event immediately. `pending` keeps the event pending for calendar admin approval. Defaults to `auto` when omitted.
`eventId`	`string`	Event ID, this usually starts with evt-

LocationGoogle

Resolves a Google Maps Place ID for a city.

Field	Type	Description
`type` *	`string`	—
`placeId` *	`string`	min length 1

LocationLookup

Searches Google Maps for a city matching query (e.g. “Miami Beach, FL”) and uses the top result.

Field	Type	Description
`type` *	`string`	—
`query` *	`string`	min length 1

EventDefaults

Settings new events on this calendar start with. Only the provided fields change, and existing events aren’t affected. visibility: 'members-only' requires a membership tier on the calendar.

Field	Type	Description
`visibility`	Visibility	Visibility of new events. `members-only` requires a membership tier on the calendar.
`showGuestList`	`boolean`	Whether new events show their guest list.
`feedbackEmail`	EventDefaultsFeedbackEmail	Whether new events send the post-event feedback email. Each event can override this with its own `feedback_email`.

EventDefaultsFeedbackEmail

Whether new events send the post-event feedback email. Each event can override this with its own feedback_email.

Field	Type	Description
`enabled` *	`boolean`	—

MembershipStatus

Value
`approved`
`pending`
`approved-pending-payment`
`declined`

CalendarsContactsListSortColumn

Value
`created_at`
`event_checked_in_count`
`event_approved_count`
`name`
`revenue_usd_cents`

Color

Value
`cranberry`
`barney`
`red`
`green`
`blue`
`purple`
`yellow`
`orange`

LaunchStatus

Value
`launched`
`coming-soon`
`archived`

​Model tree

​CalendarsEventsAddBodyExternal

​CalendarsEventsAddBodyLuma

​LocationGoogle

​LocationLookup

​EventDefaults

​EventDefaultsFeedbackEmail

​MembershipStatus

​CalendarsContactsListSortColumn

​Color

​LaunchStatus

Model tree

CalendarsEventsAddBodyExternal

CalendarsEventsAddBodyLuma

LocationGoogle

LocationLookup

EventDefaults

EventDefaultsFeedbackEmail

MembershipStatus

CalendarsContactsListSortColumn

Color

LaunchStatus