Create a new event

Create a new event

Request Body — REQUIRED

data object — REQUIRED title Title — REQUIRED Possible values: 3 ≤ length ≤ 100 Event title description Description Event description event_type EventType — REQUIRED Possible values: [in-person, online] location Location Event location timezone Timezone Event IANA timezone utc_start_dt date-time — REQUIRED Event start date and time in UTC utc_end_dt date-time — REQUIRED Event end date and time in UTC is_recurring Is Recurring Indicates if the event is recurring cover_image_key Cover Image Key Event cover image S3 key access_code Access Code Optional access code gating public bundle visibility target_languages string[] Default translation languages for the event; pre-fills new channels listener_language_mode ListenerLanguageMode Possible values: [off, approval, auto]

Responses
200 Successful Response Schema — OPTIONAL undefined
201 Created Schema — OPTIONAL ok Ok — OPTIONAL Indicates if the request was successful or not. data object event_id uuid Event ID title Title Event title description Description — OPTIONAL Event description event_type EventType Possible values: [in-person, online] location Location — OPTIONAL Event location timezone Timezone — OPTIONAL Event IANA timezone utc_start_dt date-time Event start date and time in UTC utc_end_dt date-time Event end date and time in UTC is_recurring Is Recurring — OPTIONAL Indicates if the event is recurring cover_image_key Cover Image Key — OPTIONAL Event cover image S3 key cover_image_url Cover Image Url — OPTIONAL Event cover image URL qr_code_url uri Possible values: 1 ≤ length ≤ 2083 Event QR code URL lifecycle_status EventLifecycleStatusV2 Possible values: [setup_required, upcoming, ready, live, finished] finished_at Finished At — OPTIONAL Event completion time in UTC access_code Access Code — OPTIONAL Event access code input_languages string[] — OPTIONAL Event input languages (aggregated from channels) output_languages string[] — OPTIONAL Event output languages (aggregated from channels) target_languages string[] — OPTIONAL Organizer-configured default translation languages; pre-fills the language list when creating channels listener_language_mode ListenerLanguageMode — OPTIONAL Possible values: [off, approval, auto] utc_created_at date-time Event creation time in UTC utc_updated_at date-time Event last update time in UTC
default Default Response Schema — OPTIONAL ok Ok — OPTIONAL Indicates if the request was successful or not. errors object[] List of errors type uri Possible values: 1 ≤ length ≤ 2083 A string containing a URI reference that identifies the problem type. status Status Possible values: 399 < value < 600 A number indicating the HTTP status code. title Title Possible values: 5 ≤ length A string containing a short, human-readable summary of the problem type. detail Detail Possible values: 5 ≤ length A string containing a human-readable explanation specific to this occurrence of the problem. instance Instance Possible values: 1 ≤ length A string containing a URI reference that identifies the specific occurrence of the problem. error_code Error Code A Number that indicates the error type that occurred.