Skip to main content
POST
Resolve an event preview link

Path Parameters

clientId
integer
required

Record ID in the authenticated organization.

Example:

42

Body

application/json
preview_token
string
required

Secret token from the preview URL fragment.

Maximum string length: 128
Example:

"issued-preview-token"

Response

Resolve an event preview link completed.

name
string

Name.

Maximum string length: 255
Example:

"Annual Gala"

slug
string | null

Slug.

Maximum string length: 255
Pattern: ^[a-z0-9-]+$
Example:

"annual-gala"

description
string | null

Description.

Example:

"Example"

type
string | null

Type.

Maximum string length: 80
Example:

"Example"

status
enum<string> | null

Status.

Available options:
draft,
published,
registration_open,
registration_closed,
live,
completed,
reconciled,
archived,
null
Example:

"draft"

visibility
enum<string> | null

Visibility.

Available options:
public,
unlisted,
invite_only,
internal,
null
Example:

"public"

search_indexing_enabled
boolean | null

Search indexing enabled.

Example:

false

timezone
string | null

IANA timezone; legacy aliases are accepted except Factory. Omitted values use the organization timezone on creation.

Maximum string length: 64
Example:

"Example"

starts_at
string<date-time> | null

Starts at. Date without offset is interpreted in the event timezone.

Example:

"2026-12-20T18:00:00Z"

ends_at
string<date-time> | null

Ends at. Date without offset is interpreted in the event timezone. Must be at least starts_at.

Example:

"2026-12-20T18:00:00Z"

registration_opens_at
string<date-time> | null

Registration opens at. Date without offset is interpreted in the event timezone.

Example:

"2026-12-20T18:00:00Z"

registration_closes_at
string<date-time> | null

Registration closes at. Date without offset is interpreted in the event timezone.

Example:

"2026-12-20T18:00:00Z"

location_name
string | null

Location name.

Maximum string length: 255
Example:

"Example"

location_address
string | null

Location address.

Example:

"Example"

public_location_mode
enum<string> | null

Public location mode.

Available options:
hidden,
summary,
venue_only,
full,
null
Example:

"hidden"

public_location_summary
string | null

Public location summary.

Maximum string length: 255
Example:

"Example"

registration_identity_mode
enum<string> | null

Registration identity mode.

Available options:
minimal_rsvp,
organization_donor_form,
custom_event_fields,
null
Example:

"minimal_rsvp"

virtual_url
string | null

Always null in the public page projection.

capacity
integer | null

Capacity.

Required range: x >= 1
Example:

1

settings
object
id
integer

Event ID.

Example:

42

client_id
integer

Organization ID.

Example:

42

cover_image_url
string | null

Cover image URL.

Example:

"Example"

currency
string

ISO currency code.

Example:

"USD"

location
object
published_at
string<date-time> | null

First publication time.

Example:

"2026-10-20T12:00:00Z"

completed_at
string<date-time> | null

Completion time.

Example:

"2026-10-20T12:00:00Z"

registered_attendee_count
integer | null

Registered non-cancelled attendee count, when loaded.

Example:

42

checked_in_count
integer | null

Checked-in count, when loaded.

Example:

42

readiness
string[]

Empty in public projection.

people
object[]
ticket_types
object[]
questions
object[]

Setup rows; empty in compact mode.

sponsor_packages
object[]
tables
string[]

Empty in public projection.

auction_items
object[]
availability
object
registration_v2_enabled
boolean

Whether grouped registration features are enabled.

Example:

false

remove_branding
enum<string>

Whether organization attribution is removed.

Available options:
0,
1
Example:

"0"

branding_program_id
integer | null

Branding program context.

Example:

42

resolved_app_brand
string

Resolved app brand.

Example:

"gratona"

resolved_app_brand_source
string

Source of brand resolution.

Example:

"client"

organization
object
organization_name
string

Organization name.

Example:

"Example Foundation"

accepts_registrations
boolean

True only for an open, non-preview event.

Example:

false

preview
object | null
conversion_paths
object
form_context
object
payment_gateways
object[]

Empty in previews.

payment_methods
object[]

Empty in previews.

metadata
object