Download OpenAPI specification:Download
This is the public facing version of the Goldcast API, created for Goldcast clients to be able to create and manage their virtual events programmatically. If you want additional functionality to be added to the public API, please reach out to Goldcast Support (support@goldcast.io)
| cvent_account_mapping_id | string <uuid> |
| hubspot_portal_id | integer |
| is_active_customer | boolean |
| limit | integer Number of results to return per page. |
| name | string |
| offset | integer The initial index from which to return the results. |
| ordering | string Which field to use when ordering the results. |
| owner | string <uuid> |
| search | string A search term. |
| short_name | string |
{- "count": 123,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "workspace_settings": {
- "count": -2147483648
}, - "is_sso_enabled": "string",
- "obfuscate": true,
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "short_name": "string",
- "tier": "FREE",
- "base_marketo_program_id": "string",
- "lead_creation_preferences": null,
- "goldcast_branding_enabled": true,
- "show_templates": true,
- "show_forms": true,
- "use_bee_pro_for_reg_page": true,
- "ga_script": "string",
- "drift_script": "string",
- "tray_id": "3d6a2448-e07c-4401-bb1d-2ba3f80270fb",
- "cvent_account_mapping_id": "4c1cca94-bbd0-4ec6-af23-75d3cece5f04",
- "use_new_integrations": true,
- "allow_hybrid_events": true,
- "invite_type": "FULL_EVENT_INVITE",
- "enable_live_captions": true,
- "caption_glossary": [
- "string"
], - "enable_hls_captions": true,
- "hubspot_portal_id": -2147483648,
- "marketo_user_engagement_id": -2147483648,
- "marketo_user_profile_id": -2147483648,
- "marketo_goldcast_event_custom_activity_id": -2147483648,
- "marketo_goldcast_generic_custom_activity_id": -2147483648,
- "has_marketo_api_permissions": true,
- "can_create_live_hybrid_broadcasts": true,
- "no_of_organizer_seats": 0,
- "can_change_event_length": true,
- "can_add_track": true,
- "can_create_rtmp_broadcast": true,
- "pass_vivenu_props_in_activity": true,
- "enabled_rtmp_out": true,
- "enabled_appbase_sync": true,
- "show_advanced_branding_tab": true,
- "show_secondary_booth_tab": true,
- "is_ux_translation_enabled": true,
- "is_webhook_enabled": true,
- "is_kudo_enabled": true,
- "is_booths_tab_enabled": true,
- "contract_start_date": "2019-08-24T14:15:22Z",
- "contract_end_date": "2019-08-24T14:15:22Z",
- "email_sender": "string",
- "email_domain_verified": true,
- "postmark_signature_id": -9223372036854776000,
- "postmark_domain_id": -9223372036854776000,
- "event_domain_settings": null,
- "registration_app_vanity_domain_settings": null,
- "allow_token_creation": true,
- "allow_booth_tiers": true,
- "enable_reg_page_builder": true,
- "enable_virtual_event": true,
- "allow_whitelabel": true,
- "enable_inhouse_simulive": true,
- "vivenu_api_key": "string",
- "sso_type": "ADFS_SAML",
- "workos_connection_id": "string",
- "is_registrant_activity_enabled": true,
- "anonymize_log_rocket": true,
- "can_create_hub_pages": true,
- "use_new_studio_app": true,
- "event_summary_dashboard_available": true,
- "show_breakout_room_cta": true,
- "transcoder_type": "MEDIACONVERT",
- "use_snowflake_dashboards": true,
- "salesforce_org_id": "string",
- "cross_event_report_available": true,
- "disable_non_sso_admin_logins": true,
- "fix_max_video_quality_with_vb": true,
- "enable_reg_form_validations": true,
- "eloqua_form_id": -2147483648,
- "in_person_events_enabled": true,
- "content_lab_enabled": true,
- "is_workspace_enabled": true,
- "use_profile_tags": true,
- "is_content_lab_standalone": true,
- "enable_old_reg_pages": true,
- "is_series_enabled": true,
- "is_prerecorded_session_enabled": true,
- "enable_live_captions_translations": true,
- "is_translations_enabled": true,
- "is_multi_day_session_track_enabled": true,
- "is_magiclink_sync_to_map_enabled": true,
- "is_roi_dashboard_enabled": true,
- "is_marketo_enabled": true,
- "is_eloqua_enabled": true,
- "is_pardot_enabled": true,
- "is_salesforce_enabled": true,
- "is_slack_enabled": true,
- "is_slack_salesforce_enabled": true,
- "is_drift_enabled": true,
- "is_wistia_enabled": true,
- "customer_type": "NONE",
- "is_active_customer": true,
- "created_by_cvent": true,
- "org_creation_source": "goldcast",
- "add_ons": "string",
- "allowed_event_count": -2147483648,
- "is_repeating_events_enabled": true,
- "is_waitlist_enabled": true,
- "is_free_trial": true,
- "content_video_duration": 0,
- "content_clips_count": 0,
- "is_tentpole": true,
- "is_renewal": true,
- "newbie_content_user": true,
- "clip_generation_algo_type": "TEXT_EMBEDDING_3_SMALL",
- "permissions_enabled": true,
- "is_event_roles_enabled": true,
- "enable_registrant_cap": true,
- "blacklisted_emojis": [
- "string"
], - "make_registrant_producer": true,
- "cloudproxy_mode": 0,
- "is_re_registration_email_sent_enabled": true,
- "show_new_entry_experience": true,
- "no_of_content_lab_seats": -2147483648,
- "email_service_provider": "POSTMARK",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}
]
}| id required | string <uuid> A UUID string identifying this organization. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "workspace_settings": {
- "count": -2147483648
}, - "is_sso_enabled": "string",
- "obfuscate": true,
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "short_name": "string",
- "tier": "FREE",
- "base_marketo_program_id": "string",
- "lead_creation_preferences": null,
- "goldcast_branding_enabled": true,
- "show_templates": true,
- "show_forms": true,
- "use_bee_pro_for_reg_page": true,
- "ga_script": "string",
- "drift_script": "string",
- "tray_id": "3d6a2448-e07c-4401-bb1d-2ba3f80270fb",
- "cvent_account_mapping_id": "4c1cca94-bbd0-4ec6-af23-75d3cece5f04",
- "use_new_integrations": true,
- "allow_hybrid_events": true,
- "invite_type": "FULL_EVENT_INVITE",
- "enable_live_captions": true,
- "caption_glossary": [
- "string"
], - "enable_hls_captions": true,
- "hubspot_portal_id": -2147483648,
- "marketo_user_engagement_id": -2147483648,
- "marketo_user_profile_id": -2147483648,
- "marketo_goldcast_event_custom_activity_id": -2147483648,
- "marketo_goldcast_generic_custom_activity_id": -2147483648,
- "has_marketo_api_permissions": true,
- "can_create_live_hybrid_broadcasts": true,
- "no_of_organizer_seats": 0,
- "can_change_event_length": true,
- "can_add_track": true,
- "can_create_rtmp_broadcast": true,
- "pass_vivenu_props_in_activity": true,
- "enabled_rtmp_out": true,
- "enabled_appbase_sync": true,
- "show_advanced_branding_tab": true,
- "show_secondary_booth_tab": true,
- "is_ux_translation_enabled": true,
- "is_webhook_enabled": true,
- "is_kudo_enabled": true,
- "is_booths_tab_enabled": true,
- "contract_start_date": "2019-08-24T14:15:22Z",
- "contract_end_date": "2019-08-24T14:15:22Z",
- "email_sender": "string",
- "email_domain_verified": true,
- "postmark_signature_id": -9223372036854776000,
- "postmark_domain_id": -9223372036854776000,
- "event_domain_settings": null,
- "registration_app_vanity_domain_settings": null,
- "allow_token_creation": true,
- "allow_booth_tiers": true,
- "enable_reg_page_builder": true,
- "enable_virtual_event": true,
- "allow_whitelabel": true,
- "enable_inhouse_simulive": true,
- "vivenu_api_key": "string",
- "sso_type": "ADFS_SAML",
- "workos_connection_id": "string",
- "is_registrant_activity_enabled": true,
- "anonymize_log_rocket": true,
- "can_create_hub_pages": true,
- "use_new_studio_app": true,
- "event_summary_dashboard_available": true,
- "show_breakout_room_cta": true,
- "transcoder_type": "MEDIACONVERT",
- "use_snowflake_dashboards": true,
- "salesforce_org_id": "string",
- "cross_event_report_available": true,
- "disable_non_sso_admin_logins": true,
- "fix_max_video_quality_with_vb": true,
- "enable_reg_form_validations": true,
- "eloqua_form_id": -2147483648,
- "in_person_events_enabled": true,
- "content_lab_enabled": true,
- "is_workspace_enabled": true,
- "use_profile_tags": true,
- "is_content_lab_standalone": true,
- "enable_old_reg_pages": true,
- "is_series_enabled": true,
- "is_prerecorded_session_enabled": true,
- "enable_live_captions_translations": true,
- "is_translations_enabled": true,
- "is_multi_day_session_track_enabled": true,
- "is_magiclink_sync_to_map_enabled": true,
- "is_roi_dashboard_enabled": true,
- "is_marketo_enabled": true,
- "is_eloqua_enabled": true,
- "is_pardot_enabled": true,
- "is_salesforce_enabled": true,
- "is_slack_enabled": true,
- "is_slack_salesforce_enabled": true,
- "is_drift_enabled": true,
- "is_wistia_enabled": true,
- "customer_type": "NONE",
- "is_active_customer": true,
- "created_by_cvent": true,
- "org_creation_source": "goldcast",
- "add_ons": "string",
- "allowed_event_count": -2147483648,
- "is_repeating_events_enabled": true,
- "is_waitlist_enabled": true,
- "is_free_trial": true,
- "content_video_duration": 0,
- "content_clips_count": 0,
- "is_tentpole": true,
- "is_renewal": true,
- "newbie_content_user": true,
- "clip_generation_algo_type": "TEXT_EMBEDDING_3_SMALL",
- "permissions_enabled": true,
- "is_event_roles_enabled": true,
- "enable_registrant_cap": true,
- "blacklisted_emojis": [
- "string"
], - "make_registrant_producer": true,
- "cloudproxy_mode": 0,
- "is_re_registration_email_sent_enabled": true,
- "show_new_entry_experience": true,
- "no_of_content_lab_seats": -2147483648,
- "email_service_provider": "POSTMARK",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}API endpoint that allows tags to library to be edited, deleted or added
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| ordering | string Which field to use when ordering the results. |
| organization | string <uuid> |
| tag_name | string |
{- "count": 123,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "tag_name": "string"
}
]
}API endpoint that allows tags to library to be edited, deleted or added
| id required | string <uuid> A UUID string identifying this tag library. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "tag_name": "string"
}| analytics_script_ran_successfully | boolean |
| created_at | string <date-time> |
| created_at_gte | string <date-time> |
| created_at_lte | string <date-time> |
| description | string |
| end_time | string <date-time> |
| end_time_gt | string <date-time> |
| end_time_gte | string <date-time> |
| end_time_lt | string <date-time> |
| end_time_lte | string <date-time> |
| event_type | Array of strings or null Items Enum: "Conference" "Recording" "Webinar" decide the type of an event
|
| have_broadcasts | boolean |
| have_discussions | boolean |
| host_type | string |
| internal_session_checkin | boolean |
| is_onsite | boolean |
| is_test | boolean Filter events by test status |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| on_demand_mode | boolean Filter events by on-demand status |
| ordering | string Which field to use when ordering the results. |
| organization | string <uuid> |
| search | string |
| series | string <uuid> |
| series_type | string Enum: "default" "repeating" Type of series
|
| short_name | string |
| start_time | string <date-time> |
| start_time_gt | string <date-time> |
| start_time_gte | string <date-time> |
| start_time_lt | string <date-time> |
| start_time_lte | string <date-time> |
| tag | Array of strings |
| title | string |
| updated_at | string <date-time> |
| updated_at_gte | string <date-time> |
| updated_at_lte | string <date-time> |
| user | string |
| user_email | string |
| vivenu_event_id | string |
| workspace | string <uuid> |
| workspace__isnull | boolean |
{- "count": 123,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timezone": "string",
- "csv_data": "string",
- "manual_breakout": true,
- "supported_languages": [
- {
- "code": "string",
- "name": "string",
- "native_name": "string"
}
], - "events_app_languages": [
- {
- "code": "string",
- "name": "string",
- "native_name": "string"
}
], - "vivenu_event_url": "string",
- "is_single_session": false,
- "created_by_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "updated_by_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "splash_tracking_pixel_snippet": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "head_section_script": "string",
- "body_section_script": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom_event_script": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe"
}, - "registrant_count": "string",
- "registration_cta_link": "string",
- "event_type": "Conference",
- "broadcast_type": "LIVE_HYBRID",
- "event_creation_source": "goldcast",
- "metadata": {
- "property1": null,
- "property2": null
}, - "recording_state": "string",
- "registration_form_data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "is_one_click_enabled": true,
- "form_type": "SINGLE_EVENT",
- "is_default": true,
- "is_global_form": true,
- "schema_url": "string",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "cvent_event_id": "string",
- "cvent_environment": "string",
- "series": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "registrant_count": "string",
- "contains_waitlist_event": "string",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "updated_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "upcoming_event_count": "string",
- "attendee_count": "string",
- "registration_form_url": "string",
- "blueprint_event": "string",
- "repeating_event_sync_allowed": true,
- "next_event_generation_time": "string",
- "initial_event_generated": true,
- "tags": "string",
- "registration_form_data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "is_one_click_enabled": true,
- "form_type": "SINGLE_EVENT",
- "is_default": true,
- "is_global_form": true,
- "schema_url": "string",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "builder_html": "string",
- "builder_raw_json": "string",
- "marketo_base_program_id": "string",
- "marketo_program_folder_id": -2147483648,
- "marketo_program_folder_name": "string",
- "marketo_settings": null,
- "marketo_status": true,
- "email_alias_name": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "type": "default",
- "schedule": "string",
- "initial_event_generation_count": 1,
- "total_event_threshold": 1,
- "end_date_threshold": "2019-08-24",
- "schedule_status": "LIVE",
- "frequency": 1,
- "unit": "days",
- "sync_status": "IDLE",
- "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "registration_form": "d2b4ac8a-f10a-45f2-a0f3-4db879f54214",
- "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89"
}, - "tags": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "workspace": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "icon": "string",
- "color": "string"
}, - "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "discussions_chat_disabled": true,
- "discussion_room_tab_title": "string",
- "show_booths": true,
- "booth_chat_disabled": true,
- "booth_tab_title": "string",
- "booth_tab_title_2": "string",
- "show_attendees": true,
- "p2p_chat_disabled": true,
- "floating_emoji_reactions_enabled": true,
- "event_catch_me_up_enabled": true,
- "show_attendee_profiles": true,
- "people_tab_title": "string",
- "speaker_tab_visible": true,
- "speaker_tab_title": "string",
- "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "gifs_enabled": true,
- "is_text_qna_moderated": true,
- "have_text_qna": true,
- "have_video_qna": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "email_alias_name": "string",
- "demo_request_message": "string",
- "broadcast_chat_disabled": true,
- "anonymous_qna_enabled": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string",
- "is_title_visible": true,
- "is_date_visible": true,
- "is_logo_visible": true,
- "disable_enter_event_button": true,
- "enable_tech_check": true,
- "show_onboarding": true,
- "show_discussion_rooms": true,
- "title": "string",
- "description": "string",
- "theme_obj": null,
- "default_language": "string",
- "enable_booth_tiers": true,
- "groups_enabled": true,
- "show_ticker": true,
- "show_speakers_reg_page": true,
- "hide_event_agenda": true,
- "default_language_dropdown_enabled": true,
- "enable_speaker_tech_check": true,
- "enable_goldbot": true,
- "demo_request_title": "string",
- "demo_request_button_text": "string",
- "demo_link_enabled": true,
- "demo_requests_enabled": true,
- "show_booth_rooms": true,
- "show_event_booths": true,
- "show_registration_share": true,
- "show_registration_page": true,
- "show_banner_gradient": true,
- "show_agenda": true,
- "have_broadcasts": true,
- "have_discussions": true,
- "have_resources": true,
- "theme_layout": "string",
- "registration_page_title": "string",
- "show_people_tab_speakers": true,
- "registration_page_no_agenda": true,
- "event_location_in_email": "string",
- "email_body_text": "string",
- "subject_in_email": "string",
- "assign_speaker_qna": true,
- "on_demand_demo_link_enabled": true,
- "enable_full_hd": true,
- "speaker_stage_mode": "INVITE_SPEAKER",
- "microphone_control_mode": "ASK_TO_UNMUTE",
- "demo_request_submit_type": "ONE_CLICK",
- "demo_request_consent_title": "string",
- "demo_request_disclosure_text": "string",
- "use_sso_for_events_app": true,
- "ai_generated_builder_json_metadata": null,
- "short_id": 0,
- "short_name": "string",
- "responsive": true,
- "location": "string",
- "registration_limit": -2147483648,
- "registration_support_mail": "user@example.com",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "invite_type": "FULL_EVENT_INVITE",
- "cta_link": "string",
- "cta_title": "string",
- "landing_design": -2147483648,
- "currency": "string",
- "price": 0.1,
- "paid": true,
- "show_event_type": true,
- "show_user_email_on_modals": true,
- "magic_link_enabled": true,
- "record_broadcasts": true,
- "record_discussion_rooms": true,
- "show_email_onboarding": true,
- "tab_descriptions": null,
- "video_quality": "string",
- "room_video_quality": "string",
- "calendar_unique_key": "string",
- "calendar_id": "string",
- "mmid": "string",
- "meta_tag": null,
- "main_app_form_fields": null,
- "is_public": true,
- "has_pre_event_mode": true,
- "form_fields": null,
- "hubspot_form_id": "string",
- "salesforce_campaign_id": "string",
- "marketo_campaign_id": "string",
- "slack_channel_id": "string",
- "slack_plus_salesforce_channel_id": "string",
- "wistia_project_id": "string",
- "hubspot_status": true,
- "marketo_status": true,
- "salesforce_status": true,
- "pardot_status": true,
- "eloqua_status": true,
- "hubspot_config": null,
- "marketo_config": null,
- "salesforce_config": null,
- "integration_errors": null,
- "integration_config_updated": null,
- "hubspot_settings": null,
- "marketo_settings": null,
- "salesforce_settings": null,
- "eloqua_settings": null,
- "pardot_list": null,
- "form_id_list": [
- "string"
], - "mail_reminder_intervals": [
- -2147483648
], - "is_active": true,
- "is_hybrid": true,
- "roll_video_url": "string",
- "demo_link": "string",
- "video_cdn_enabled": true,
- "internal_name": "string",
- "enabled_email_recepient": true,
- "email_calendar": true,
- "is_onsite": true,
- "allow_in_person_check_in": true,
- "drift_bot_enabled": true,
- "drift_landing_enabled": true,
- "drift_landing_as_default": true,
- "drift_tab_name": "string",
- "mobile_link_type": "Youtube",
- "mobile_link_url": "string",
- "post_registration_conditions": null,
- "enable_hls_captions": true,
- "is_test": true,
- "use_flatfile": true,
- "is_postmark": true,
- "analytics_script_ran_successfully": true,
- "broadcast_filler_image_s3_path": "string",
- "broadcast_filler_video_s3_path": "string",
- "broadcast_filler_state": "PROCESSING",
- "allow_sponsor_access": true,
- "notify_salesforce_owner_enabled": true,
- "validar_guid": "string",
- "hidden_agenda_text": "string",
- "member_level_magic_links": true,
- "ticker_text": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "tickets_enabled": true,
- "vivenu_event_id": "string",
- "self_serve_groups_enabled": true,
- "is_auto_redirections_enabled": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "magic_link_ttl_mins": -2147483648,
- "tracking_configs": null,
- "builder_html": "string",
- "builder_raw_json": "string",
- "regpage_html_staging": "string",
- "primary_booth_tier_texts": null,
- "secondary_booth_tier_texts": null,
- "internal_session_checkin": true,
- "scalability_flags": null,
- "channel_sync_triggered": true,
- "custom_domain": "string",
- "force_use_inhouse_simulive_flow": true,
- "reg_page_builder_type": "default",
- "use_mm_sockets": true,
- "manual_redirection_enabled": true,
- "can_speaker_toggle_session_liveness": true,
- "host_type": "Hybrid",
- "waitlist_enabled": true,
- "use_new_stage_controls": true,
- "is_blueprint": true,
- "sync_status": "IDLE",
- "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",
- "ondemand_builder_config": null,
- "ondemand_embed_config": null,
- "supported_captions_languages": [
- "en"
], - "mm_session_token_extending_time": "2019-08-24T14:15:22Z",
- "is_new_entry_experience_enabled": true,
- "is_local_recording": true,
- "is_record_now": true,
- "event_end_status": "NONE",
- "event_ended_at": "2019-08-24T14:15:22Z",
- "locale": "zh-CN",
- "enable_content_processing": true,
- "use_teleprompter": true,
- "is_ai_insights_enabled": true,
- "chat_visibilty": "PUBLIC",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "registration_form": "d2b4ac8a-f10a-45f2-a0f3-4db879f54214",
- "registration_page": "df58ed99-8981-464a-9a11-b21b377ec797",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
- "stage_roll_video_asset": "2195df49-a488-42e9-8915-7e8c84d37d54",
- "filler_slide": "deb19fea-dd3e-4c52-8ee1-82a109b4a929",
- "studio_event_template": "dc8f5231-81e6-45a0-8f9d-2e0c29a57e9e"
}
]
}Cvent Security Role: events:write
Cvent Auth Methods: bearer
| timezone required | string non-empty |
| csv_data | string or null non-empty |
| track_order | Array of strings <uuid> [ items <uuid > ] |
| ticker_url | string or null <uri> |
| is_single_session | boolean Default: false |
object | |
| event_type | string Default: "Conference" Enum: "Webinar" "Conference" "Recording"
|
| broadcast_type | string Default: "LIVE_HYBRID" Enum: "LIVE" "LIVE_EXTERNAL" "LIVE_HYBRID" "LIVE_EXTERNAL_HYBRID" "SIMULIVE" "INHOUSE_SIMULIVE" "HYBRID_SIMULIVE" "IN_PERSON_HYBRID"
|
(EventCreationSourceEnum (string or null)) or (NullEnum (any or null)) | |
| user_intent | string Enum: "user_delete" "look_and_feel_update" "registration_page_update"
|
| cvent_event_id | string or null [ 1 .. 255 ] characters |
| cvent_environment | string or null [ 1 .. 255 ] characters |
| created_at | string or null <date-time> |
| discussions_chat_disabled | boolean |
| discussion_room_tab_title | string or null <= 255 characters |
| show_booths | boolean Responsible for showing booths on registration app |
| booth_chat_disabled | boolean |
| booth_tab_title | string or null <= 255 characters |
| booth_tab_title_2 | string or null <= 255 characters |
| show_attendees | boolean Determines if People tab should be visible in event app |
| p2p_chat_disabled | boolean Determines if Direct Messages should be disabled in Event Chat |
| floating_emoji_reactions_enabled | boolean Floating emoji reactions should be enabled in event app |
| event_catch_me_up_enabled | boolean or null Determines if Catch Me Up feature should be enabled in event app |
| show_attendee_profiles | boolean Determines if clicking on attendee name should be allowed to view their profile |
| people_tab_title | string or null <= 255 characters |
| speaker_tab_visible | boolean |
| speaker_tab_title | string or null <= 255 characters Alternative text for default text of Speakers tab (GS-3869) |
| public_chat_disabled | boolean |
| thread_chat_disabled | boolean Disables threaded chat conversations |
| gifs_enabled | boolean Decides whether GIF support is enabled for event |
| is_text_qna_moderated | boolean |
| have_text_qna | boolean or null |
| have_video_qna | boolean or null |
| enable_live_captions | boolean enables the generation of captions in recorder |
| enable_live_captions_translations | boolean enables the generation of translated captions in recorder |
| email_alias_name | string or null <= 255 characters |
| demo_request_message | string non-empty |
| broadcast_chat_disabled | boolean |
| anonymous_qna_enabled | boolean Decide where attendees can ask questions anonymously in an event |
| show_answerers_identity | boolean Decide whether to show answerers identity in QnA |
| textqna_answerers_alias | string or null Decide whether to show answerers alias in QnA |
| is_title_visible | boolean |
| is_date_visible | boolean |
| is_logo_visible | boolean |
| disable_enter_event_button | boolean |
| enable_tech_check | boolean |
| show_onboarding | boolean |
| logo_url | string or null <uri> [ 1 .. 1024 ] characters |
| favicon | string or null <uri> [ 1 .. 1024 ] characters |
| show_discussion_rooms | boolean Responsible for showing discussion rooms on events app |
| title required | string [ 1 .. 255 ] characters |
| description | string or null |
| theme_obj | any |
| default_language | string [ 1 .. 6 ] characters field to select the language for an event |
| enable_booth_tiers | boolean Decides whether organizer enables the booth tiers for event |
| social_media_thumbnail | string or null <uri> <= 1024 characters Thumbnail URL to display if registration pages are shared on social websites |
| groups_enabled | boolean Are groups enabled? |
| show_ticker | boolean Is ticker published? |
| show_speakers_reg_page | boolean If False, speaker section on registration page will be hidden |
| hide_event_agenda | boolean Agenda will not be displayed on Event Splash page if this is true (GS-3780) |
| enable_speaker_tech_check | boolean |
| enable_goldbot | boolean |
| demo_request_title | string [ 1 .. 128 ] characters |
| demo_request_button_text | string [ 1 .. 127 ] characters |
| demo_link_enabled | boolean |
| demo_requests_enabled | boolean |
| show_booth_rooms | boolean Responsible for showing rooms in booths on events app |
| show_event_booths | boolean Responsible for showing booths on events app |
| show_registration_share | boolean |
| show_registration_page | boolean |
| show_banner_gradient | boolean |
| show_agenda | boolean |
| have_broadcasts | boolean or null |
| have_discussions | boolean or null |
| have_resources | boolean or null |
| banner_url | string or null <uri> [ 1 .. 1024 ] characters |
| landing_image_url | string or null <uri> [ 1 .. 1024 ] characters |
| theme_layout | string or null <= 63 characters |
| registration_page_title | string or null <= 255 characters |
| show_people_tab_speakers | boolean Decides if people tab is enabled for speakers/organizers |
| registration_page_no_agenda | boolean |
| event_location_in_email | string or null Event location to be shown in email |
| email_body_text | string or null Email body text that can act as description for the event calendar invite |
| subject_in_email | string or null <= 255 characters Subject to be shown in calendar invite |
| assign_speaker_qna | boolean Flag to indicate if speaker can assign questions to other speakers |
| on_demand_demo_link_enabled | boolean Flag to indicate if on_demand demo link is enabled |
| enable_full_hd | boolean Flag to decide whether 1080p streaming will be available |
| speaker_stage_mode | string Enum: "INVITE_SPEAKER" "PUSH_SPEAKER" Decides whether speakers will be asked to come on stage or will be pushed to stage
|
| microphone_control_mode | string Enum: "ASK_TO_UNMUTE" "DIRECT_UNMUTE" Decides whether producers can ask speakers to unmute or speakers can forcefully unmute other speakers
|
(DemoRequestSubmitTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) ONE_CLICK: Attendees see immediate confirmation for demo request. TWO_STEP: Shows confirmation message before sending demo request.
| |
| demo_request_consent_title | string or null <= 255 characters Title of consent dialog for two-step demo request |
| demo_request_disclosure_text | string or null Disclosure text shown in two-step demo request confirmation |
| use_sso_for_events_app | boolean Whether to use SSO login links instead of the magic links on the reminder emails and the calender invite link |
| ai_generated_builder_json_metadata | any or null Metadata related to builder JSON generated by AI, like variation saved |
| short_name | string or null [ 1 .. 63 ] characters |
| responsive | boolean |
| location | string or null Physical Location of the Event to be shown in Hybrid Events |
| registration_limit | integer or null [ -2147483648 .. 2147483647 ] Adds a limit on the number of registration for a particular event |
| registration_support_mail | string or null <email> [ 1 .. 254 ] characters |
| start_time required | string <date-time> |
| end_time required | string <date-time> |
(InviteTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| cta_link | string or null <= 1024 characters |
| cta_title | string or null <= 63 characters |
| landing_design | integer or null [ -2147483648 .. 2147483647 ] |
| currency | string or null <= 63 characters |
| price | number or null <double> |
| paid | boolean or null |
| show_event_type | boolean |
| show_user_email_on_modals | boolean |
| magic_link_enabled | boolean |
| record_broadcasts | boolean |
| record_discussion_rooms | boolean |
| show_email_onboarding | boolean To decide if on-boarding ui should be shown or not |
| tab_descriptions | any |
| video_quality | string or null <= 15 characters |
| room_video_quality | string or null <= 15 characters |
| calendar_unique_key | string or null <= 31 characters |
| calendar_id | string or null <= 31 characters |
| mmid | string [ 1 .. 26 ] characters |
| meta_tag | any |
| main_app_form_fields | any |
| is_public | boolean |
| has_pre_event_mode | boolean |
| form_fields | any |
| hubspot_form_id | string or null <= 63 characters |
| salesforce_campaign_id | string or null <= 63 characters |
| marketo_campaign_id | string or null <= 63 characters |
| slack_channel_id | string or null <= 63 characters |
| slack_plus_salesforce_channel_id | string or null <= 63 characters |
| wistia_project_id | string or null <= 63 characters |
| hubspot_status | boolean |
| marketo_status | boolean |
| salesforce_status | boolean |
| pardot_status | boolean Pardot is enabled at event level or not. |
| eloqua_status | boolean Eloqua is enabled at event level or not. |
| hubspot_config | any or null |
| marketo_config | any or null |
| salesforce_config | any or null |
| integration_errors | any or null Stores the errors related to integrations |
| integration_config_updated | any or null Stores the config updated information related to integrations |
| hubspot_settings | any or null |
| marketo_settings | any or null |
| salesforce_settings | any or null |
| eloqua_settings | any or null Store the eloqua activites settings |
| pardot_list | any or null list of json object which contain info related to pardot list ID. |
| form_id_list | Array of strings[ items [ 1 .. 31 ] characters ] |
| mail_reminder_intervals | Array of integers[ items [ -2147483648 .. 2147483647 ] ] |
| is_active | boolean |
| preview_image_url | string or null <uri> [ 1 .. 1024 ] characters |
| roll_video_url | string or null <= 1024 characters |
| demo_link | string or null <= 1024 characters |
| video_cdn_enabled | boolean |
| internal_name | string or null <= 255 characters Internal name for the event, visible only to organizers |
| enabled_email_recepient | boolean |
| email_calendar | boolean |
| is_onsite | boolean Denote whether an event is an onsite, was created for field-drive, can be deprecated shortly |
| allow_in_person_check_in | boolean Decides whether in-person check-ins are allowed via 3rd party systems like Validar for hybrid events |
| drift_bot_enabled | boolean |
| drift_landing_enabled | boolean |
| drift_landing_url | string or null <uri> [ 1 .. 1024 ] characters |
| drift_landing_as_default | boolean |
| drift_tab_name | string [ 1 .. 10 ] characters |
(MobileLinkTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| mobile_link_url | string or null <= 1024 characters |
| post_registration_conditions | any |
| enable_hls_captions | boolean enables the generation of captioned hls streams |
| is_test | boolean |
| use_flatfile | boolean flag to decide if flatfile embedded form should be used |
| is_postmark | boolean flag to decide if emails are sent using postmark(True)/SES(false) |
| analytics_script_ran_successfully | boolean flag to check if analytic script ran successfully |
| broadcast_filler_state | string (BroadcastFillerStateEnum) Enum: "PROCESSING" "STOPPED" "ERRORED"
|
| allow_sponsor_access | boolean |
| notify_salesforce_owner_enabled | boolean Points to notify button of slack + salesforce solution instance for an event in admin panel |
| validar_leaderboard_url | string or null <uri> [ 1 .. 1024 ] characters Points to a validar leaderboard url for an event |
| validar_guid | string or null [ 1 .. 255 ] characters A field that maps goldcast's event with validar's event (eventGuid) |
| hidden_agenda_text | string or null [ 1 .. 255 ] characters Text to be shown if agenda is hidden in event splash page. Null will be handled as default in events app. (GS-3780) |
| member_level_magic_links | boolean If True, magic links for this event are event user level, otherwise - user level |
| ticker_text | string or null Ticker message |
| parent | string or null <uuid> Parent event id if duplicated |
| tickets_enabled | boolean Are tickets enabled? |
| vivenu_event_id | string or null [ 1 .. 24 ] characters One-One mapping of this Event with Vivenu Event. |
| self_serve_groups_enabled | boolean Is self serve groups UI enabled? |
| is_auto_redirections_enabled | boolean Enable Auto Redirection of Attendees in Event |
| recorder_event_app_domain | string or null <uri> [ 1 .. 200 ] characters Event app domain for recorder,if left null will go to hardcoded default! |
| is_available_on_demand | boolean Allows organizers to set an event to be delivered on-demand 24 hrs after event ends. Needs to be set 1 hr before event starts along with record_broadcasts and record_discussion_groups. |
| on_demand_mode | boolean Signifies that the event is now in on-demand serving mode. Will be set automatically by backend once all the recording assets are available after 24hrs have passed event's end time |
| magic_link_ttl_mins | integer or null [ -2147483648 .. 2147483647 ] Magic Link expiry duration in minutes |
| tracking_configs | any or null Contains all the tracking configurations required for registration pages like custom script tags etc |
| builder_html | string or null <= 255 characters HTML file path to be used build the registration page |
| builder_raw_json | string or null <= 255 characters Raw JSON file path to be used build the registration page |
| regpage_html_staging | string or null <= 255 characters Staging HTML file path to be used build the registration page |
| primary_booth_tier_texts | any Contains text mapping for each booth tier which will be shown in frontend |
| secondary_booth_tier_texts | any Contains text mapping for each secondary booth tier which will be shown in frontend |
| internal_session_checkin | boolean Flag for internal session checkin |
| scalability_flags | any This field will be used for Frontend to store key value configs to decide certain things to be toggled on/off mainly related to scale |
| channel_sync_triggered | boolean This field will be used to initiate broadcast channel sync via cron flow, event with this flag set means that this event had already synced its broadcast channel previously |
| custom_domain | string or null <= 255 characters Custom domain for the event |
| force_use_inhouse_simulive_flow | boolean This field will be used to force the use of INHOUSE_SIMULIVE flow for SIMULIVE type broadcasts. Changing this field should do a realtime switch to the old SIMULIVE flows for an event. This field is only to be used while production testing of INHOUSE_SIMULIVE. For prod release of the feature we will migrate all existing SIMULIVE broadcasts in the system to the INHOUSE_SIMULIVE flow. |
| reg_page_builder_type | string Enum: "default" "grapejs" "newbuilder" This field will be used to decided registration page builder with default value as null. This field also depends on core_organization.enable_reg_page_builder if this flag is true value of this field will be newbuilder else it will be null during event creation time
|
| registration_app_domain | string or null <uri> <= 1024 characters Registration app domain for the event |
| on_demand_app_url | string or null <uri> <= 1024 characters On-demand app url for the event |
| use_mm_sockets | boolean Used by frontend to decided whether they want to consume sockets coming from mattermost |
| manual_redirection_enabled | boolean Flag to indicate if session redirection in the event will be manual or automatic |
| can_speaker_toggle_session_liveness | boolean Flag to indicate if manual session redirection can be done by speakers |
| host_type | string Enum: "Hybrid" "Virtual" "In_Person" This field will be used to decide the host type of the event
|
| waitlist_enabled | boolean Whether to use waitlist feature or not |
| use_new_stage_controls | boolean Flag to indicate new stage controls to be used on event app |
| sync_status | string Enum: "IDLE" "IN_PROGRESS" "FAILED" Sync status for child event of repeating event
|
| sync_id | string or null <uuid> Sync id to identify the sync process |
| ondemand_builder_config | any or null Stores ondemand page builder config |
| ondemand_embed_config | any or null Stores ondemand embed builder config |
| supported_captions_languages | Array of strings or null (SupportedCaptionsLanguagesEnum) Enum: "en" "es" "zh" "ja" "ko" "de" "it" "fr" "nl" "pt" "pl" "ru" "tr" "th" "vi" "hr" "zh-TW" "es-MX" "da" "sv" "no" "fi" "hu" "cs" "ar" Stores the languages for which captions are supported |
| mm_session_token_extending_time | string or null <date-time> Stores the time when mm token for all users was extended |
| is_new_entry_experience_enabled | boolean Flag to indicate if new event entry experience is enabled |
| is_local_recording | boolean whether to record the broadcast locally |
| is_record_now | boolean Indicates if the recording event is record now or record later. |
(EventEndStatusEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) Status indicating how the event ended
| |
| event_ended_at | string or null <date-time> Timestamp when the event was ended |
| locale | string Enum: "zh-CN" "zh-TW" "en-US" "en-GB" "en-AU" "en-IN" "de-DE" "ja-JA" "es-ES" "ko-KR" "fr-FR" "fr-CA" "nl-NL" "pt-PT" "tr-TR" "ru-RU" "it-IT" "th-TH" "vi-VN" "hr-HR" "pl-PL" Locale string (e.g., en-US, en-GB, fr-FR) for event-specific formatting
|
| enable_content_processing | boolean or null Indicates whether content lab processing pipeline should be triggered for event recording or not |
| use_teleprompter | boolean Indicates whether teleprompter should be used for event or not |
| is_ai_insights_enabled | boolean Indicates whether ai insights should be used for event or not |
| chat_visibilty | string (ChatVisibiltyEnum) Enum: "PUBLIC" "PRIVATE" "OFF"
|
| created_by | string or null <uuid> The user that created this entry |
| updated_by | string or null <uuid> The user that created updated this entry |
| marketing_tags | string or null <uuid> |
| organization required | string <uuid> |
| registration_form | string or null <uuid> A 1(event):1(form) mapping to render the FormIo form |
| registration_page | string or null <uuid> maps the organization level registration template to an event |
| owner required | string <uuid> |
| stage_roll_video_asset | string or null <uuid> |
| filler_slide | string or null <uuid> Filler slide from library to be used for this event |
| studio_event_template | string or null <uuid> Studio template used to create this event |
| series | string or null <uuid> |
| workspace | string or null <uuid> |
{- "timezone": "string",
- "csv_data": "string",
- "track_order": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "is_single_session": false,
- "event_tags": {
- "entity_tags": [
- {
- "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
- "entity_type": "Event",
- "tag": "ac5f6b7f-bb01-4c1e-a5c0-7a9f62d81c22"
}
]
}, - "event_type": "Conference",
- "broadcast_type": "LIVE_HYBRID",
- "event_creation_source": "goldcast",
- "user_intent": "user_delete",
- "cvent_event_id": "string",
- "cvent_environment": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "discussions_chat_disabled": true,
- "discussion_room_tab_title": "string",
- "show_booths": true,
- "booth_chat_disabled": true,
- "booth_tab_title": "string",
- "booth_tab_title_2": "string",
- "show_attendees": true,
- "p2p_chat_disabled": true,
- "floating_emoji_reactions_enabled": true,
- "event_catch_me_up_enabled": true,
- "show_attendee_profiles": true,
- "people_tab_title": "string",
- "speaker_tab_visible": true,
- "speaker_tab_title": "string",
- "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "gifs_enabled": true,
- "is_text_qna_moderated": true,
- "have_text_qna": true,
- "have_video_qna": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "email_alias_name": "string",
- "demo_request_message": "string",
- "broadcast_chat_disabled": true,
- "anonymous_qna_enabled": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string",
- "is_title_visible": true,
- "is_date_visible": true,
- "is_logo_visible": true,
- "disable_enter_event_button": true,
- "enable_tech_check": true,
- "show_onboarding": true,
- "show_discussion_rooms": true,
- "title": "string",
- "description": "string",
- "theme_obj": null,
- "default_language": "string",
- "enable_booth_tiers": true,
- "groups_enabled": true,
- "show_ticker": true,
- "show_speakers_reg_page": true,
- "hide_event_agenda": true,
- "enable_speaker_tech_check": true,
- "enable_goldbot": true,
- "demo_request_title": "string",
- "demo_request_button_text": "string",
- "demo_link_enabled": true,
- "demo_requests_enabled": true,
- "show_booth_rooms": true,
- "show_event_booths": true,
- "show_registration_share": true,
- "show_registration_page": true,
- "show_banner_gradient": true,
- "show_agenda": true,
- "have_broadcasts": true,
- "have_discussions": true,
- "have_resources": true,
- "theme_layout": "string",
- "registration_page_title": "string",
- "show_people_tab_speakers": true,
- "registration_page_no_agenda": true,
- "event_location_in_email": "string",
- "email_body_text": "string",
- "subject_in_email": "string",
- "assign_speaker_qna": true,
- "on_demand_demo_link_enabled": true,
- "enable_full_hd": true,
- "speaker_stage_mode": "INVITE_SPEAKER",
- "microphone_control_mode": "ASK_TO_UNMUTE",
- "demo_request_submit_type": "ONE_CLICK",
- "demo_request_consent_title": "string",
- "demo_request_disclosure_text": "string",
- "use_sso_for_events_app": true,
- "ai_generated_builder_json_metadata": null,
- "short_name": "string",
- "responsive": true,
- "location": "string",
- "registration_limit": -2147483648,
- "registration_support_mail": "user@example.com",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "invite_type": "FULL_EVENT_INVITE",
- "cta_link": "string",
- "cta_title": "string",
- "landing_design": -2147483648,
- "currency": "string",
- "price": 0.1,
- "paid": true,
- "show_event_type": true,
- "show_user_email_on_modals": true,
- "magic_link_enabled": true,
- "record_broadcasts": true,
- "record_discussion_rooms": true,
- "show_email_onboarding": true,
- "tab_descriptions": null,
- "video_quality": "string",
- "room_video_quality": "string",
- "calendar_unique_key": "string",
- "calendar_id": "string",
- "mmid": "string",
- "meta_tag": null,
- "main_app_form_fields": null,
- "is_public": true,
- "has_pre_event_mode": true,
- "form_fields": null,
- "hubspot_form_id": "string",
- "salesforce_campaign_id": "string",
- "marketo_campaign_id": "string",
- "slack_channel_id": "string",
- "slack_plus_salesforce_channel_id": "string",
- "wistia_project_id": "string",
- "hubspot_status": true,
- "marketo_status": true,
- "salesforce_status": true,
- "pardot_status": true,
- "eloqua_status": true,
- "hubspot_config": null,
- "marketo_config": null,
- "salesforce_config": null,
- "integration_errors": null,
- "integration_config_updated": null,
- "hubspot_settings": null,
- "marketo_settings": null,
- "salesforce_settings": null,
- "eloqua_settings": null,
- "pardot_list": null,
- "form_id_list": [
- "string"
], - "mail_reminder_intervals": [
- -2147483648
], - "is_active": true,
- "roll_video_url": "string",
- "demo_link": "string",
- "video_cdn_enabled": true,
- "internal_name": "string",
- "enabled_email_recepient": true,
- "email_calendar": true,
- "is_onsite": true,
- "allow_in_person_check_in": true,
- "drift_bot_enabled": true,
- "drift_landing_enabled": true,
- "drift_landing_as_default": true,
- "drift_tab_name": "string",
- "mobile_link_type": "Youtube",
- "mobile_link_url": "string",
- "post_registration_conditions": null,
- "enable_hls_captions": true,
- "is_test": true,
- "use_flatfile": true,
- "is_postmark": true,
- "analytics_script_ran_successfully": true,
- "broadcast_filler_state": "PROCESSING",
- "allow_sponsor_access": true,
- "notify_salesforce_owner_enabled": true,
- "validar_guid": "string",
- "hidden_agenda_text": "string",
- "member_level_magic_links": true,
- "ticker_text": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "tickets_enabled": true,
- "vivenu_event_id": "string",
- "self_serve_groups_enabled": true,
- "is_auto_redirections_enabled": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "magic_link_ttl_mins": -2147483648,
- "tracking_configs": null,
- "builder_html": "string",
- "builder_raw_json": "string",
- "regpage_html_staging": "string",
- "primary_booth_tier_texts": null,
- "secondary_booth_tier_texts": null,
- "internal_session_checkin": true,
- "scalability_flags": null,
- "channel_sync_triggered": true,
- "custom_domain": "string",
- "force_use_inhouse_simulive_flow": true,
- "reg_page_builder_type": "default",
- "use_mm_sockets": true,
- "manual_redirection_enabled": true,
- "can_speaker_toggle_session_liveness": true,
- "host_type": "Hybrid",
- "waitlist_enabled": true,
- "use_new_stage_controls": true,
- "sync_status": "IDLE",
- "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",
- "ondemand_builder_config": null,
- "ondemand_embed_config": null,
- "supported_captions_languages": [
- "en"
], - "mm_session_token_extending_time": "2019-08-24T14:15:22Z",
- "is_new_entry_experience_enabled": true,
- "is_local_recording": true,
- "is_record_now": true,
- "event_end_status": "NONE",
- "event_ended_at": "2019-08-24T14:15:22Z",
- "locale": "zh-CN",
- "enable_content_processing": true,
- "use_teleprompter": true,
- "is_ai_insights_enabled": true,
- "chat_visibilty": "PUBLIC",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "registration_form": "d2b4ac8a-f10a-45f2-a0f3-4db879f54214",
- "registration_page": "df58ed99-8981-464a-9a11-b21b377ec797",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
- "stage_roll_video_asset": "2195df49-a488-42e9-8915-7e8c84d37d54",
- "filler_slide": "deb19fea-dd3e-4c52-8ee1-82a109b4a929",
- "studio_event_template": "dc8f5231-81e6-45a0-8f9d-2e0c29a57e9e",
- "series": "41145f9c-df72-4764-8701-78239ee0e3bd",
- "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timezone": "string",
- "csv_data": "string",
- "manual_breakout": true,
- "supported_languages": [
- {
- "code": "string",
- "name": "string",
- "native_name": "string"
}
], - "events_app_languages": [
- {
- "code": "string",
- "name": "string",
- "native_name": "string"
}
], - "vivenu_event_url": "string",
- "is_single_session": false,
- "created_by_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "updated_by_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "splash_tracking_pixel_snippet": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "head_section_script": "string",
- "body_section_script": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom_event_script": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe"
}, - "registrant_count": "string",
- "registration_cta_link": "string",
- "event_type": "Conference",
- "broadcast_type": "LIVE_HYBRID",
- "event_creation_source": "goldcast",
- "metadata": {
- "property1": null,
- "property2": null
}, - "recording_state": "string",
- "registration_form_data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "is_one_click_enabled": true,
- "form_type": "SINGLE_EVENT",
- "is_default": true,
- "is_global_form": true,
- "schema_url": "string",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "cvent_event_id": "string",
- "cvent_environment": "string",
- "series": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "registrant_count": "string",
- "contains_waitlist_event": "string",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "updated_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "upcoming_event_count": "string",
- "attendee_count": "string",
- "registration_form_url": "string",
- "blueprint_event": "string",
- "repeating_event_sync_allowed": true,
- "next_event_generation_time": "string",
- "initial_event_generated": true,
- "tags": "string",
- "registration_form_data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "is_one_click_enabled": true,
- "form_type": "SINGLE_EVENT",
- "is_default": true,
- "is_global_form": true,
- "schema_url": "string",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "builder_html": "string",
- "builder_raw_json": "string",
- "marketo_base_program_id": "string",
- "marketo_program_folder_id": -2147483648,
- "marketo_program_folder_name": "string",
- "marketo_settings": null,
- "marketo_status": true,
- "email_alias_name": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "type": "default",
- "schedule": "string",
- "initial_event_generation_count": 1,
- "total_event_threshold": 1,
- "end_date_threshold": "2019-08-24",
- "schedule_status": "LIVE",
- "frequency": 1,
- "unit": "days",
- "sync_status": "IDLE",
- "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "registration_form": "d2b4ac8a-f10a-45f2-a0f3-4db879f54214",
- "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89"
}, - "tags": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "workspace": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "icon": "string",
- "color": "string"
}, - "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "discussions_chat_disabled": true,
- "discussion_room_tab_title": "string",
- "show_booths": true,
- "booth_chat_disabled": true,
- "booth_tab_title": "string",
- "booth_tab_title_2": "string",
- "show_attendees": true,
- "p2p_chat_disabled": true,
- "floating_emoji_reactions_enabled": true,
- "event_catch_me_up_enabled": true,
- "show_attendee_profiles": true,
- "people_tab_title": "string",
- "speaker_tab_visible": true,
- "speaker_tab_title": "string",
- "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "gifs_enabled": true,
- "is_text_qna_moderated": true,
- "have_text_qna": true,
- "have_video_qna": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "email_alias_name": "string",
- "demo_request_message": "string",
- "broadcast_chat_disabled": true,
- "anonymous_qna_enabled": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string",
- "is_title_visible": true,
- "is_date_visible": true,
- "is_logo_visible": true,
- "disable_enter_event_button": true,
- "enable_tech_check": true,
- "show_onboarding": true,
- "show_discussion_rooms": true,
- "title": "string",
- "description": "string",
- "theme_obj": null,
- "default_language": "string",
- "enable_booth_tiers": true,
- "groups_enabled": true,
- "show_ticker": true,
- "show_speakers_reg_page": true,
- "hide_event_agenda": true,
- "default_language_dropdown_enabled": true,
- "enable_speaker_tech_check": true,
- "enable_goldbot": true,
- "demo_request_title": "string",
- "demo_request_button_text": "string",
- "demo_link_enabled": true,
- "demo_requests_enabled": true,
- "show_booth_rooms": true,
- "show_event_booths": true,
- "show_registration_share": true,
- "show_registration_page": true,
- "show_banner_gradient": true,
- "show_agenda": true,
- "have_broadcasts": true,
- "have_discussions": true,
- "have_resources": true,
- "theme_layout": "string",
- "registration_page_title": "string",
- "show_people_tab_speakers": true,
- "registration_page_no_agenda": true,
- "event_location_in_email": "string",
- "email_body_text": "string",
- "subject_in_email": "string",
- "assign_speaker_qna": true,
- "on_demand_demo_link_enabled": true,
- "enable_full_hd": true,
- "speaker_stage_mode": "INVITE_SPEAKER",
- "microphone_control_mode": "ASK_TO_UNMUTE",
- "demo_request_submit_type": "ONE_CLICK",
- "demo_request_consent_title": "string",
- "demo_request_disclosure_text": "string",
- "use_sso_for_events_app": true,
- "ai_generated_builder_json_metadata": null,
- "short_id": 0,
- "short_name": "string",
- "responsive": true,
- "location": "string",
- "registration_limit": -2147483648,
- "registration_support_mail": "user@example.com",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "invite_type": "FULL_EVENT_INVITE",
- "cta_link": "string",
- "cta_title": "string",
- "landing_design": -2147483648,
- "currency": "string",
- "price": 0.1,
- "paid": true,
- "show_event_type": true,
- "show_user_email_on_modals": true,
- "magic_link_enabled": true,
- "record_broadcasts": true,
- "record_discussion_rooms": true,
- "show_email_onboarding": true,
- "tab_descriptions": null,
- "video_quality": "string",
- "room_video_quality": "string",
- "calendar_unique_key": "string",
- "calendar_id": "string",
- "mmid": "string",
- "meta_tag": null,
- "main_app_form_fields": null,
- "is_public": true,
- "has_pre_event_mode": true,
- "form_fields": null,
- "hubspot_form_id": "string",
- "salesforce_campaign_id": "string",
- "marketo_campaign_id": "string",
- "slack_channel_id": "string",
- "slack_plus_salesforce_channel_id": "string",
- "wistia_project_id": "string",
- "hubspot_status": true,
- "marketo_status": true,
- "salesforce_status": true,
- "pardot_status": true,
- "eloqua_status": true,
- "hubspot_config": null,
- "marketo_config": null,
- "salesforce_config": null,
- "integration_errors": null,
- "integration_config_updated": null,
- "hubspot_settings": null,
- "marketo_settings": null,
- "salesforce_settings": null,
- "eloqua_settings": null,
- "pardot_list": null,
- "form_id_list": [
- "string"
], - "mail_reminder_intervals": [
- -2147483648
], - "is_active": true,
- "is_hybrid": true,
- "roll_video_url": "string",
- "demo_link": "string",
- "video_cdn_enabled": true,
- "internal_name": "string",
- "enabled_email_recepient": true,
- "email_calendar": true,
- "is_onsite": true,
- "allow_in_person_check_in": true,
- "drift_bot_enabled": true,
- "drift_landing_enabled": true,
- "drift_landing_as_default": true,
- "drift_tab_name": "string",
- "mobile_link_type": "Youtube",
- "mobile_link_url": "string",
- "post_registration_conditions": null,
- "enable_hls_captions": true,
- "is_test": true,
- "use_flatfile": true,
- "is_postmark": true,
- "analytics_script_ran_successfully": true,
- "broadcast_filler_image_s3_path": "string",
- "broadcast_filler_video_s3_path": "string",
- "broadcast_filler_state": "PROCESSING",
- "allow_sponsor_access": true,
- "notify_salesforce_owner_enabled": true,
- "validar_guid": "string",
- "hidden_agenda_text": "string",
- "member_level_magic_links": true,
- "ticker_text": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "tickets_enabled": true,
- "vivenu_event_id": "string",
- "self_serve_groups_enabled": true,
- "is_auto_redirections_enabled": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "magic_link_ttl_mins": -2147483648,
- "tracking_configs": null,
- "builder_html": "string",
- "builder_raw_json": "string",
- "regpage_html_staging": "string",
- "primary_booth_tier_texts": null,
- "secondary_booth_tier_texts": null,
- "internal_session_checkin": true,
- "scalability_flags": null,
- "channel_sync_triggered": true,
- "custom_domain": "string",
- "force_use_inhouse_simulive_flow": true,
- "reg_page_builder_type": "default",
- "use_mm_sockets": true,
- "manual_redirection_enabled": true,
- "can_speaker_toggle_session_liveness": true,
- "host_type": "Hybrid",
- "waitlist_enabled": true,
- "use_new_stage_controls": true,
- "is_blueprint": true,
- "sync_status": "IDLE",
- "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",
- "ondemand_builder_config": null,
- "ondemand_embed_config": null,
- "supported_captions_languages": [
- "en"
], - "mm_session_token_extending_time": "2019-08-24T14:15:22Z",
- "is_new_entry_experience_enabled": true,
- "is_local_recording": true,
- "is_record_now": true,
- "event_end_status": "NONE",
- "event_ended_at": "2019-08-24T14:15:22Z",
- "locale": "zh-CN",
- "enable_content_processing": true,
- "use_teleprompter": true,
- "is_ai_insights_enabled": true,
- "chat_visibilty": "PUBLIC",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "registration_form": "d2b4ac8a-f10a-45f2-a0f3-4db879f54214",
- "registration_page": "df58ed99-8981-464a-9a11-b21b377ec797",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
- "stage_roll_video_asset": "2195df49-a488-42e9-8915-7e8c84d37d54",
- "filler_slide": "deb19fea-dd3e-4c52-8ee1-82a109b4a929",
- "studio_event_template": "dc8f5231-81e6-45a0-8f9d-2e0c29a57e9e"
}| id required | string <uuid> A UUID string identifying this event. |
| timezone required | string non-empty |
| csv_data | string or null non-empty |
| track_order | Array of strings <uuid> [ items <uuid > ] |
| ticker_url | string or null <uri> |
| is_single_session | boolean Default: false |
object | |
| event_type | string Default: "Conference" Enum: "Webinar" "Conference" "Recording"
|
| broadcast_type | string Default: "LIVE_HYBRID" Enum: "LIVE" "LIVE_EXTERNAL" "LIVE_HYBRID" "LIVE_EXTERNAL_HYBRID" "SIMULIVE" "INHOUSE_SIMULIVE" "HYBRID_SIMULIVE" "IN_PERSON_HYBRID"
|
(EventCreationSourceEnum (string or null)) or (NullEnum (any or null)) | |
| user_intent | string Enum: "user_delete" "look_and_feel_update" "registration_page_update"
|
| cvent_event_id | string or null [ 1 .. 255 ] characters |
| cvent_environment | string or null [ 1 .. 255 ] characters |
| created_at | string or null <date-time> |
| discussions_chat_disabled | boolean |
| discussion_room_tab_title | string or null <= 255 characters |
| show_booths | boolean Responsible for showing booths on registration app |
| booth_chat_disabled | boolean |
| booth_tab_title | string or null <= 255 characters |
| booth_tab_title_2 | string or null <= 255 characters |
| show_attendees | boolean Determines if People tab should be visible in event app |
| p2p_chat_disabled | boolean Determines if Direct Messages should be disabled in Event Chat |
| floating_emoji_reactions_enabled | boolean Floating emoji reactions should be enabled in event app |
| event_catch_me_up_enabled | boolean or null Determines if Catch Me Up feature should be enabled in event app |
| show_attendee_profiles | boolean Determines if clicking on attendee name should be allowed to view their profile |
| people_tab_title | string or null <= 255 characters |
| speaker_tab_visible | boolean |
| speaker_tab_title | string or null <= 255 characters Alternative text for default text of Speakers tab (GS-3869) |
| public_chat_disabled | boolean |
| thread_chat_disabled | boolean Disables threaded chat conversations |
| gifs_enabled | boolean Decides whether GIF support is enabled for event |
| is_text_qna_moderated | boolean |
| have_text_qna | boolean or null |
| have_video_qna | boolean or null |
| enable_live_captions | boolean enables the generation of captions in recorder |
| enable_live_captions_translations | boolean enables the generation of translated captions in recorder |
| email_alias_name | string or null <= 255 characters |
| demo_request_message | string non-empty |
| broadcast_chat_disabled | boolean |
| anonymous_qna_enabled | boolean Decide where attendees can ask questions anonymously in an event |
| show_answerers_identity | boolean Decide whether to show answerers identity in QnA |
| textqna_answerers_alias | string or null Decide whether to show answerers alias in QnA |
| is_title_visible | boolean |
| is_date_visible | boolean |
| is_logo_visible | boolean |
| disable_enter_event_button | boolean |
| enable_tech_check | boolean |
| show_onboarding | boolean |
| logo_url | string or null <uri> [ 1 .. 1024 ] characters |
| favicon | string or null <uri> [ 1 .. 1024 ] characters |
| show_discussion_rooms | boolean Responsible for showing discussion rooms on events app |
| title required | string [ 1 .. 255 ] characters |
| description | string or null |
| theme_obj | any |
| default_language | string [ 1 .. 6 ] characters field to select the language for an event |
| enable_booth_tiers | boolean Decides whether organizer enables the booth tiers for event |
| social_media_thumbnail | string or null <uri> <= 1024 characters Thumbnail URL to display if registration pages are shared on social websites |
| groups_enabled | boolean Are groups enabled? |
| show_ticker | boolean Is ticker published? |
| show_speakers_reg_page | boolean If False, speaker section on registration page will be hidden |
| hide_event_agenda | boolean Agenda will not be displayed on Event Splash page if this is true (GS-3780) |
| enable_speaker_tech_check | boolean |
| enable_goldbot | boolean |
| demo_request_title | string [ 1 .. 128 ] characters |
| demo_request_button_text | string [ 1 .. 127 ] characters |
| demo_link_enabled | boolean |
| demo_requests_enabled | boolean |
| show_booth_rooms | boolean Responsible for showing rooms in booths on events app |
| show_event_booths | boolean Responsible for showing booths on events app |
| show_registration_share | boolean |
| show_registration_page | boolean |
| show_banner_gradient | boolean |
| show_agenda | boolean |
| have_broadcasts | boolean or null |
| have_discussions | boolean or null |
| have_resources | boolean or null |
| banner_url | string or null <uri> [ 1 .. 1024 ] characters |
| landing_image_url | string or null <uri> [ 1 .. 1024 ] characters |
| theme_layout | string or null <= 63 characters |
| registration_page_title | string or null <= 255 characters |
| show_people_tab_speakers | boolean Decides if people tab is enabled for speakers/organizers |
| registration_page_no_agenda | boolean |
| event_location_in_email | string or null Event location to be shown in email |
| email_body_text | string or null Email body text that can act as description for the event calendar invite |
| subject_in_email | string or null <= 255 characters Subject to be shown in calendar invite |
| assign_speaker_qna | boolean Flag to indicate if speaker can assign questions to other speakers |
| on_demand_demo_link_enabled | boolean Flag to indicate if on_demand demo link is enabled |
| enable_full_hd | boolean Flag to decide whether 1080p streaming will be available |
| speaker_stage_mode | string Enum: "INVITE_SPEAKER" "PUSH_SPEAKER" Decides whether speakers will be asked to come on stage or will be pushed to stage
|
| microphone_control_mode | string Enum: "ASK_TO_UNMUTE" "DIRECT_UNMUTE" Decides whether producers can ask speakers to unmute or speakers can forcefully unmute other speakers
|
(DemoRequestSubmitTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) ONE_CLICK: Attendees see immediate confirmation for demo request. TWO_STEP: Shows confirmation message before sending demo request.
| |
| demo_request_consent_title | string or null <= 255 characters Title of consent dialog for two-step demo request |
| demo_request_disclosure_text | string or null Disclosure text shown in two-step demo request confirmation |
| use_sso_for_events_app | boolean Whether to use SSO login links instead of the magic links on the reminder emails and the calender invite link |
| ai_generated_builder_json_metadata | any or null Metadata related to builder JSON generated by AI, like variation saved |
| short_name | string or null [ 1 .. 63 ] characters |
| responsive | boolean |
| location | string or null Physical Location of the Event to be shown in Hybrid Events |
| registration_limit | integer or null [ -2147483648 .. 2147483647 ] Adds a limit on the number of registration for a particular event |
| registration_support_mail | string or null <email> [ 1 .. 254 ] characters |
| start_time required | string <date-time> |
| end_time required | string <date-time> |
(InviteTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| cta_link | string or null <= 1024 characters |
| cta_title | string or null <= 63 characters |
| landing_design | integer or null [ -2147483648 .. 2147483647 ] |
| currency | string or null <= 63 characters |
| price | number or null <double> |
| paid | boolean or null |
| show_event_type | boolean |
| show_user_email_on_modals | boolean |
| magic_link_enabled | boolean |
| record_broadcasts | boolean |
| record_discussion_rooms | boolean |
| show_email_onboarding | boolean To decide if on-boarding ui should be shown or not |
| tab_descriptions | any |
| video_quality | string or null <= 15 characters |
| room_video_quality | string or null <= 15 characters |
| calendar_unique_key | string or null <= 31 characters |
| calendar_id | string or null <= 31 characters |
| mmid | string [ 1 .. 26 ] characters |
| meta_tag | any |
| main_app_form_fields | any |
| is_public | boolean |
| has_pre_event_mode | boolean |
| form_fields | any |
| hubspot_form_id | string or null <= 63 characters |
| salesforce_campaign_id | string or null <= 63 characters |
| marketo_campaign_id | string or null <= 63 characters |
| slack_channel_id | string or null <= 63 characters |
| slack_plus_salesforce_channel_id | string or null <= 63 characters |
| wistia_project_id | string or null <= 63 characters |
| hubspot_status | boolean |
| marketo_status | boolean |
| salesforce_status | boolean |
| pardot_status | boolean Pardot is enabled at event level or not. |
| eloqua_status | boolean Eloqua is enabled at event level or not. |
| hubspot_config | any or null |
| marketo_config | any or null |
| salesforce_config | any or null |
| integration_errors | any or null Stores the errors related to integrations |
| integration_config_updated | any or null Stores the config updated information related to integrations |
| hubspot_settings | any or null |
| marketo_settings | any or null |
| salesforce_settings | any or null |
| eloqua_settings | any or null Store the eloqua activites settings |
| pardot_list | any or null list of json object which contain info related to pardot list ID. |
| form_id_list | Array of strings[ items [ 1 .. 31 ] characters ] |
| mail_reminder_intervals | Array of integers[ items [ -2147483648 .. 2147483647 ] ] |
| is_active | boolean |
| preview_image_url | string or null <uri> [ 1 .. 1024 ] characters |
| roll_video_url | string or null <= 1024 characters |
| demo_link | string or null <= 1024 characters |
| video_cdn_enabled | boolean |
| internal_name | string or null <= 255 characters Internal name for the event, visible only to organizers |
| enabled_email_recepient | boolean |
| email_calendar | boolean |
| is_onsite | boolean Denote whether an event is an onsite, was created for field-drive, can be deprecated shortly |
| allow_in_person_check_in | boolean Decides whether in-person check-ins are allowed via 3rd party systems like Validar for hybrid events |
| drift_bot_enabled | boolean |
| drift_landing_enabled | boolean |
| drift_landing_url | string or null <uri> [ 1 .. 1024 ] characters |
| drift_landing_as_default | boolean |
| drift_tab_name | string [ 1 .. 10 ] characters |
(MobileLinkTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| mobile_link_url | string or null <= 1024 characters |
| post_registration_conditions | any |
| enable_hls_captions | boolean enables the generation of captioned hls streams |
| is_test | boolean |
| use_flatfile | boolean flag to decide if flatfile embedded form should be used |
| is_postmark | boolean flag to decide if emails are sent using postmark(True)/SES(false) |
| analytics_script_ran_successfully | boolean flag to check if analytic script ran successfully |
| broadcast_filler_state | string (BroadcastFillerStateEnum) Enum: "PROCESSING" "STOPPED" "ERRORED"
|
| allow_sponsor_access | boolean |
| notify_salesforce_owner_enabled | boolean Points to notify button of slack + salesforce solution instance for an event in admin panel |
| validar_leaderboard_url | string or null <uri> [ 1 .. 1024 ] characters Points to a validar leaderboard url for an event |
| validar_guid | string or null [ 1 .. 255 ] characters A field that maps goldcast's event with validar's event (eventGuid) |
| hidden_agenda_text | string or null [ 1 .. 255 ] characters Text to be shown if agenda is hidden in event splash page. Null will be handled as default in events app. (GS-3780) |
| member_level_magic_links | boolean If True, magic links for this event are event user level, otherwise - user level |
| ticker_text | string or null Ticker message |
| parent | string or null <uuid> Parent event id if duplicated |
| tickets_enabled | boolean Are tickets enabled? |
| vivenu_event_id | string or null [ 1 .. 24 ] characters One-One mapping of this Event with Vivenu Event. |
| self_serve_groups_enabled | boolean Is self serve groups UI enabled? |
| is_auto_redirections_enabled | boolean Enable Auto Redirection of Attendees in Event |
| recorder_event_app_domain | string or null <uri> [ 1 .. 200 ] characters Event app domain for recorder,if left null will go to hardcoded default! |
| is_available_on_demand | boolean Allows organizers to set an event to be delivered on-demand 24 hrs after event ends. Needs to be set 1 hr before event starts along with record_broadcasts and record_discussion_groups. |
| on_demand_mode | boolean Signifies that the event is now in on-demand serving mode. Will be set automatically by backend once all the recording assets are available after 24hrs have passed event's end time |
| magic_link_ttl_mins | integer or null [ -2147483648 .. 2147483647 ] Magic Link expiry duration in minutes |
| tracking_configs | any or null Contains all the tracking configurations required for registration pages like custom script tags etc |
| builder_html | string or null <= 255 characters HTML file path to be used build the registration page |
| builder_raw_json | string or null <= 255 characters Raw JSON file path to be used build the registration page |
| regpage_html_staging | string or null <= 255 characters Staging HTML file path to be used build the registration page |
| primary_booth_tier_texts | any Contains text mapping for each booth tier which will be shown in frontend |
| secondary_booth_tier_texts | any Contains text mapping for each secondary booth tier which will be shown in frontend |
| internal_session_checkin | boolean Flag for internal session checkin |
| scalability_flags | any This field will be used for Frontend to store key value configs to decide certain things to be toggled on/off mainly related to scale |
| channel_sync_triggered | boolean This field will be used to initiate broadcast channel sync via cron flow, event with this flag set means that this event had already synced its broadcast channel previously |
| custom_domain | string or null <= 255 characters Custom domain for the event |
| force_use_inhouse_simulive_flow | boolean This field will be used to force the use of INHOUSE_SIMULIVE flow for SIMULIVE type broadcasts. Changing this field should do a realtime switch to the old SIMULIVE flows for an event. This field is only to be used while production testing of INHOUSE_SIMULIVE. For prod release of the feature we will migrate all existing SIMULIVE broadcasts in the system to the INHOUSE_SIMULIVE flow. |
| reg_page_builder_type | string Enum: "default" "grapejs" "newbuilder" This field will be used to decided registration page builder with default value as null. This field also depends on core_organization.enable_reg_page_builder if this flag is true value of this field will be newbuilder else it will be null during event creation time
|
| registration_app_domain | string or null <uri> <= 1024 characters Registration app domain for the event |
| on_demand_app_url | string or null <uri> <= 1024 characters On-demand app url for the event |
| use_mm_sockets | boolean Used by frontend to decided whether they want to consume sockets coming from mattermost |
| manual_redirection_enabled | boolean Flag to indicate if session redirection in the event will be manual or automatic |
| can_speaker_toggle_session_liveness | boolean Flag to indicate if manual session redirection can be done by speakers |
| host_type | string Enum: "Hybrid" "Virtual" "In_Person" This field will be used to decide the host type of the event
|
| waitlist_enabled | boolean Whether to use waitlist feature or not |
| use_new_stage_controls | boolean Flag to indicate new stage controls to be used on event app |
| sync_status | string Enum: "IDLE" "IN_PROGRESS" "FAILED" Sync status for child event of repeating event
|
| sync_id | string or null <uuid> Sync id to identify the sync process |
| ondemand_builder_config | any or null Stores ondemand page builder config |
| ondemand_embed_config | any or null Stores ondemand embed builder config |
| supported_captions_languages | Array of strings or null (SupportedCaptionsLanguagesEnum) Enum: "en" "es" "zh" "ja" "ko" "de" "it" "fr" "nl" "pt" "pl" "ru" "tr" "th" "vi" "hr" "zh-TW" "es-MX" "da" "sv" "no" "fi" "hu" "cs" "ar" Stores the languages for which captions are supported |
| mm_session_token_extending_time | string or null <date-time> Stores the time when mm token for all users was extended |
| is_new_entry_experience_enabled | boolean Flag to indicate if new event entry experience is enabled |
| is_local_recording | boolean whether to record the broadcast locally |
| is_record_now | boolean Indicates if the recording event is record now or record later. |
(EventEndStatusEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) Status indicating how the event ended
| |
| event_ended_at | string or null <date-time> Timestamp when the event was ended |
| locale | string Enum: "zh-CN" "zh-TW" "en-US" "en-GB" "en-AU" "en-IN" "de-DE" "ja-JA" "es-ES" "ko-KR" "fr-FR" "fr-CA" "nl-NL" "pt-PT" "tr-TR" "ru-RU" "it-IT" "th-TH" "vi-VN" "hr-HR" "pl-PL" Locale string (e.g., en-US, en-GB, fr-FR) for event-specific formatting
|
| enable_content_processing | boolean or null Indicates whether content lab processing pipeline should be triggered for event recording or not |
| use_teleprompter | boolean Indicates whether teleprompter should be used for event or not |
| is_ai_insights_enabled | boolean Indicates whether ai insights should be used for event or not |
| chat_visibilty | string (ChatVisibiltyEnum) Enum: "PUBLIC" "PRIVATE" "OFF"
|
| created_by | string or null <uuid> The user that created this entry |
| updated_by | string or null <uuid> The user that created updated this entry |
| marketing_tags | string or null <uuid> |
| organization required | string <uuid> |
| registration_form | string or null <uuid> A 1(event):1(form) mapping to render the FormIo form |
| registration_page | string or null <uuid> maps the organization level registration template to an event |
| owner required | string <uuid> |
| stage_roll_video_asset | string or null <uuid> |
| filler_slide | string or null <uuid> Filler slide from library to be used for this event |
| studio_event_template | string or null <uuid> Studio template used to create this event |
| series | string or null <uuid> |
| workspace | string or null <uuid> |
{- "timezone": "string",
- "csv_data": "string",
- "track_order": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "is_single_session": false,
- "event_tags": {
- "entity_tags": [
- {
- "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
- "entity_type": "Event",
- "tag": "ac5f6b7f-bb01-4c1e-a5c0-7a9f62d81c22"
}
]
}, - "event_type": "Conference",
- "broadcast_type": "LIVE_HYBRID",
- "event_creation_source": "goldcast",
- "user_intent": "user_delete",
- "cvent_event_id": "string",
- "cvent_environment": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "discussions_chat_disabled": true,
- "discussion_room_tab_title": "string",
- "show_booths": true,
- "booth_chat_disabled": true,
- "booth_tab_title": "string",
- "booth_tab_title_2": "string",
- "show_attendees": true,
- "p2p_chat_disabled": true,
- "floating_emoji_reactions_enabled": true,
- "event_catch_me_up_enabled": true,
- "show_attendee_profiles": true,
- "people_tab_title": "string",
- "speaker_tab_visible": true,
- "speaker_tab_title": "string",
- "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "gifs_enabled": true,
- "is_text_qna_moderated": true,
- "have_text_qna": true,
- "have_video_qna": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "email_alias_name": "string",
- "demo_request_message": "string",
- "broadcast_chat_disabled": true,
- "anonymous_qna_enabled": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string",
- "is_title_visible": true,
- "is_date_visible": true,
- "is_logo_visible": true,
- "disable_enter_event_button": true,
- "enable_tech_check": true,
- "show_onboarding": true,
- "show_discussion_rooms": true,
- "title": "string",
- "description": "string",
- "theme_obj": null,
- "default_language": "string",
- "enable_booth_tiers": true,
- "groups_enabled": true,
- "show_ticker": true,
- "show_speakers_reg_page": true,
- "hide_event_agenda": true,
- "enable_speaker_tech_check": true,
- "enable_goldbot": true,
- "demo_request_title": "string",
- "demo_request_button_text": "string",
- "demo_link_enabled": true,
- "demo_requests_enabled": true,
- "show_booth_rooms": true,
- "show_event_booths": true,
- "show_registration_share": true,
- "show_registration_page": true,
- "show_banner_gradient": true,
- "show_agenda": true,
- "have_broadcasts": true,
- "have_discussions": true,
- "have_resources": true,
- "theme_layout": "string",
- "registration_page_title": "string",
- "show_people_tab_speakers": true,
- "registration_page_no_agenda": true,
- "event_location_in_email": "string",
- "email_body_text": "string",
- "subject_in_email": "string",
- "assign_speaker_qna": true,
- "on_demand_demo_link_enabled": true,
- "enable_full_hd": true,
- "speaker_stage_mode": "INVITE_SPEAKER",
- "microphone_control_mode": "ASK_TO_UNMUTE",
- "demo_request_submit_type": "ONE_CLICK",
- "demo_request_consent_title": "string",
- "demo_request_disclosure_text": "string",
- "use_sso_for_events_app": true,
- "ai_generated_builder_json_metadata": null,
- "short_name": "string",
- "responsive": true,
- "location": "string",
- "registration_limit": -2147483648,
- "registration_support_mail": "user@example.com",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "invite_type": "FULL_EVENT_INVITE",
- "cta_link": "string",
- "cta_title": "string",
- "landing_design": -2147483648,
- "currency": "string",
- "price": 0.1,
- "paid": true,
- "show_event_type": true,
- "show_user_email_on_modals": true,
- "magic_link_enabled": true,
- "record_broadcasts": true,
- "record_discussion_rooms": true,
- "show_email_onboarding": true,
- "tab_descriptions": null,
- "video_quality": "string",
- "room_video_quality": "string",
- "calendar_unique_key": "string",
- "calendar_id": "string",
- "mmid": "string",
- "meta_tag": null,
- "main_app_form_fields": null,
- "is_public": true,
- "has_pre_event_mode": true,
- "form_fields": null,
- "hubspot_form_id": "string",
- "salesforce_campaign_id": "string",
- "marketo_campaign_id": "string",
- "slack_channel_id": "string",
- "slack_plus_salesforce_channel_id": "string",
- "wistia_project_id": "string",
- "hubspot_status": true,
- "marketo_status": true,
- "salesforce_status": true,
- "pardot_status": true,
- "eloqua_status": true,
- "hubspot_config": null,
- "marketo_config": null,
- "salesforce_config": null,
- "integration_errors": null,
- "integration_config_updated": null,
- "hubspot_settings": null,
- "marketo_settings": null,
- "salesforce_settings": null,
- "eloqua_settings": null,
- "pardot_list": null,
- "form_id_list": [
- "string"
], - "mail_reminder_intervals": [
- -2147483648
], - "is_active": true,
- "roll_video_url": "string",
- "demo_link": "string",
- "video_cdn_enabled": true,
- "internal_name": "string",
- "enabled_email_recepient": true,
- "email_calendar": true,
- "is_onsite": true,
- "allow_in_person_check_in": true,
- "drift_bot_enabled": true,
- "drift_landing_enabled": true,
- "drift_landing_as_default": true,
- "drift_tab_name": "string",
- "mobile_link_type": "Youtube",
- "mobile_link_url": "string",
- "post_registration_conditions": null,
- "enable_hls_captions": true,
- "is_test": true,
- "use_flatfile": true,
- "is_postmark": true,
- "analytics_script_ran_successfully": true,
- "broadcast_filler_state": "PROCESSING",
- "allow_sponsor_access": true,
- "notify_salesforce_owner_enabled": true,
- "validar_guid": "string",
- "hidden_agenda_text": "string",
- "member_level_magic_links": true,
- "ticker_text": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "tickets_enabled": true,
- "vivenu_event_id": "string",
- "self_serve_groups_enabled": true,
- "is_auto_redirections_enabled": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "magic_link_ttl_mins": -2147483648,
- "tracking_configs": null,
- "builder_html": "string",
- "builder_raw_json": "string",
- "regpage_html_staging": "string",
- "primary_booth_tier_texts": null,
- "secondary_booth_tier_texts": null,
- "internal_session_checkin": true,
- "scalability_flags": null,
- "channel_sync_triggered": true,
- "custom_domain": "string",
- "force_use_inhouse_simulive_flow": true,
- "reg_page_builder_type": "default",
- "use_mm_sockets": true,
- "manual_redirection_enabled": true,
- "can_speaker_toggle_session_liveness": true,
- "host_type": "Hybrid",
- "waitlist_enabled": true,
- "use_new_stage_controls": true,
- "sync_status": "IDLE",
- "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",
- "ondemand_builder_config": null,
- "ondemand_embed_config": null,
- "supported_captions_languages": [
- "en"
], - "mm_session_token_extending_time": "2019-08-24T14:15:22Z",
- "is_new_entry_experience_enabled": true,
- "is_local_recording": true,
- "is_record_now": true,
- "event_end_status": "NONE",
- "event_ended_at": "2019-08-24T14:15:22Z",
- "locale": "zh-CN",
- "enable_content_processing": true,
- "use_teleprompter": true,
- "is_ai_insights_enabled": true,
- "chat_visibilty": "PUBLIC",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "registration_form": "d2b4ac8a-f10a-45f2-a0f3-4db879f54214",
- "registration_page": "df58ed99-8981-464a-9a11-b21b377ec797",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
- "stage_roll_video_asset": "2195df49-a488-42e9-8915-7e8c84d37d54",
- "filler_slide": "deb19fea-dd3e-4c52-8ee1-82a109b4a929",
- "studio_event_template": "dc8f5231-81e6-45a0-8f9d-2e0c29a57e9e",
- "series": "41145f9c-df72-4764-8701-78239ee0e3bd",
- "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timezone": "string",
- "csv_data": "string",
- "manual_breakout": true,
- "supported_languages": [
- {
- "code": "string",
- "name": "string",
- "native_name": "string"
}
], - "events_app_languages": [
- {
- "code": "string",
- "name": "string",
- "native_name": "string"
}
], - "vivenu_event_url": "string",
- "is_single_session": false,
- "created_by_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "updated_by_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "splash_tracking_pixel_snippet": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "head_section_script": "string",
- "body_section_script": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom_event_script": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe"
}, - "registrant_count": "string",
- "registration_cta_link": "string",
- "event_type": "Conference",
- "broadcast_type": "LIVE_HYBRID",
- "event_creation_source": "goldcast",
- "metadata": {
- "property1": null,
- "property2": null
}, - "recording_state": "string",
- "registration_form_data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "is_one_click_enabled": true,
- "form_type": "SINGLE_EVENT",
- "is_default": true,
- "is_global_form": true,
- "schema_url": "string",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "cvent_event_id": "string",
- "cvent_environment": "string",
- "series": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "registrant_count": "string",
- "contains_waitlist_event": "string",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "updated_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "upcoming_event_count": "string",
- "attendee_count": "string",
- "registration_form_url": "string",
- "blueprint_event": "string",
- "repeating_event_sync_allowed": true,
- "next_event_generation_time": "string",
- "initial_event_generated": true,
- "tags": "string",
- "registration_form_data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "is_one_click_enabled": true,
- "form_type": "SINGLE_EVENT",
- "is_default": true,
- "is_global_form": true,
- "schema_url": "string",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "builder_html": "string",
- "builder_raw_json": "string",
- "marketo_base_program_id": "string",
- "marketo_program_folder_id": -2147483648,
- "marketo_program_folder_name": "string",
- "marketo_settings": null,
- "marketo_status": true,
- "email_alias_name": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "type": "default",
- "schedule": "string",
- "initial_event_generation_count": 1,
- "total_event_threshold": 1,
- "end_date_threshold": "2019-08-24",
- "schedule_status": "LIVE",
- "frequency": 1,
- "unit": "days",
- "sync_status": "IDLE",
- "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "registration_form": "d2b4ac8a-f10a-45f2-a0f3-4db879f54214",
- "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89"
}, - "tags": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "workspace": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "icon": "string",
- "color": "string"
}, - "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "discussions_chat_disabled": true,
- "discussion_room_tab_title": "string",
- "show_booths": true,
- "booth_chat_disabled": true,
- "booth_tab_title": "string",
- "booth_tab_title_2": "string",
- "show_attendees": true,
- "p2p_chat_disabled": true,
- "floating_emoji_reactions_enabled": true,
- "event_catch_me_up_enabled": true,
- "show_attendee_profiles": true,
- "people_tab_title": "string",
- "speaker_tab_visible": true,
- "speaker_tab_title": "string",
- "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "gifs_enabled": true,
- "is_text_qna_moderated": true,
- "have_text_qna": true,
- "have_video_qna": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "email_alias_name": "string",
- "demo_request_message": "string",
- "broadcast_chat_disabled": true,
- "anonymous_qna_enabled": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string",
- "is_title_visible": true,
- "is_date_visible": true,
- "is_logo_visible": true,
- "disable_enter_event_button": true,
- "enable_tech_check": true,
- "show_onboarding": true,
- "show_discussion_rooms": true,
- "title": "string",
- "description": "string",
- "theme_obj": null,
- "default_language": "string",
- "enable_booth_tiers": true,
- "groups_enabled": true,
- "show_ticker": true,
- "show_speakers_reg_page": true,
- "hide_event_agenda": true,
- "default_language_dropdown_enabled": true,
- "enable_speaker_tech_check": true,
- "enable_goldbot": true,
- "demo_request_title": "string",
- "demo_request_button_text": "string",
- "demo_link_enabled": true,
- "demo_requests_enabled": true,
- "show_booth_rooms": true,
- "show_event_booths": true,
- "show_registration_share": true,
- "show_registration_page": true,
- "show_banner_gradient": true,
- "show_agenda": true,
- "have_broadcasts": true,
- "have_discussions": true,
- "have_resources": true,
- "theme_layout": "string",
- "registration_page_title": "string",
- "show_people_tab_speakers": true,
- "registration_page_no_agenda": true,
- "event_location_in_email": "string",
- "email_body_text": "string",
- "subject_in_email": "string",
- "assign_speaker_qna": true,
- "on_demand_demo_link_enabled": true,
- "enable_full_hd": true,
- "speaker_stage_mode": "INVITE_SPEAKER",
- "microphone_control_mode": "ASK_TO_UNMUTE",
- "demo_request_submit_type": "ONE_CLICK",
- "demo_request_consent_title": "string",
- "demo_request_disclosure_text": "string",
- "use_sso_for_events_app": true,
- "ai_generated_builder_json_metadata": null,
- "short_id": 0,
- "short_name": "string",
- "responsive": true,
- "location": "string",
- "registration_limit": -2147483648,
- "registration_support_mail": "user@example.com",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "invite_type": "FULL_EVENT_INVITE",
- "cta_link": "string",
- "cta_title": "string",
- "landing_design": -2147483648,
- "currency": "string",
- "price": 0.1,
- "paid": true,
- "show_event_type": true,
- "show_user_email_on_modals": true,
- "magic_link_enabled": true,
- "record_broadcasts": true,
- "record_discussion_rooms": true,
- "show_email_onboarding": true,
- "tab_descriptions": null,
- "video_quality": "string",
- "room_video_quality": "string",
- "calendar_unique_key": "string",
- "calendar_id": "string",
- "mmid": "string",
- "meta_tag": null,
- "main_app_form_fields": null,
- "is_public": true,
- "has_pre_event_mode": true,
- "form_fields": null,
- "hubspot_form_id": "string",
- "salesforce_campaign_id": "string",
- "marketo_campaign_id": "string",
- "slack_channel_id": "string",
- "slack_plus_salesforce_channel_id": "string",
- "wistia_project_id": "string",
- "hubspot_status": true,
- "marketo_status": true,
- "salesforce_status": true,
- "pardot_status": true,
- "eloqua_status": true,
- "hubspot_config": null,
- "marketo_config": null,
- "salesforce_config": null,
- "integration_errors": null,
- "integration_config_updated": null,
- "hubspot_settings": null,
- "marketo_settings": null,
- "salesforce_settings": null,
- "eloqua_settings": null,
- "pardot_list": null,
- "form_id_list": [
- "string"
], - "mail_reminder_intervals": [
- -2147483648
], - "is_active": true,
- "is_hybrid": true,
- "roll_video_url": "string",
- "demo_link": "string",
- "video_cdn_enabled": true,
- "internal_name": "string",
- "enabled_email_recepient": true,
- "email_calendar": true,
- "is_onsite": true,
- "allow_in_person_check_in": true,
- "drift_bot_enabled": true,
- "drift_landing_enabled": true,
- "drift_landing_as_default": true,
- "drift_tab_name": "string",
- "mobile_link_type": "Youtube",
- "mobile_link_url": "string",
- "post_registration_conditions": null,
- "enable_hls_captions": true,
- "is_test": true,
- "use_flatfile": true,
- "is_postmark": true,
- "analytics_script_ran_successfully": true,
- "broadcast_filler_image_s3_path": "string",
- "broadcast_filler_video_s3_path": "string",
- "broadcast_filler_state": "PROCESSING",
- "allow_sponsor_access": true,
- "notify_salesforce_owner_enabled": true,
- "validar_guid": "string",
- "hidden_agenda_text": "string",
- "member_level_magic_links": true,
- "ticker_text": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "tickets_enabled": true,
- "vivenu_event_id": "string",
- "self_serve_groups_enabled": true,
- "is_auto_redirections_enabled": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "magic_link_ttl_mins": -2147483648,
- "tracking_configs": null,
- "builder_html": "string",
- "builder_raw_json": "string",
- "regpage_html_staging": "string",
- "primary_booth_tier_texts": null,
- "secondary_booth_tier_texts": null,
- "internal_session_checkin": true,
- "scalability_flags": null,
- "channel_sync_triggered": true,
- "custom_domain": "string",
- "force_use_inhouse_simulive_flow": true,
- "reg_page_builder_type": "default",
- "use_mm_sockets": true,
- "manual_redirection_enabled": true,
- "can_speaker_toggle_session_liveness": true,
- "host_type": "Hybrid",
- "waitlist_enabled": true,
- "use_new_stage_controls": true,
- "is_blueprint": true,
- "sync_status": "IDLE",
- "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",
- "ondemand_builder_config": null,
- "ondemand_embed_config": null,
- "supported_captions_languages": [
- "en"
], - "mm_session_token_extending_time": "2019-08-24T14:15:22Z",
- "is_new_entry_experience_enabled": true,
- "is_local_recording": true,
- "is_record_now": true,
- "event_end_status": "NONE",
- "event_ended_at": "2019-08-24T14:15:22Z",
- "locale": "zh-CN",
- "enable_content_processing": true,
- "use_teleprompter": true,
- "is_ai_insights_enabled": true,
- "chat_visibilty": "PUBLIC",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "registration_form": "d2b4ac8a-f10a-45f2-a0f3-4db879f54214",
- "registration_page": "df58ed99-8981-464a-9a11-b21b377ec797",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
- "stage_roll_video_asset": "2195df49-a488-42e9-8915-7e8c84d37d54",
- "filler_slide": "deb19fea-dd3e-4c52-8ee1-82a109b4a929",
- "studio_event_template": "dc8f5231-81e6-45a0-8f9d-2e0c29a57e9e"
}Cvent Security Role: events:write
Cvent Auth Methods: bearer
| id required | string <uuid> A UUID string identifying this event. |
| timezone | string non-empty |
| csv_data | string or null non-empty |
| track_order | Array of strings <uuid> [ items <uuid > ] |
| ticker_url | string or null <uri> |
| is_single_session | boolean Default: false |
object | |
| event_type | string Default: "Conference" Enum: "Webinar" "Conference" "Recording"
|
| broadcast_type | string Default: "LIVE_HYBRID" Enum: "LIVE" "LIVE_EXTERNAL" "LIVE_HYBRID" "LIVE_EXTERNAL_HYBRID" "SIMULIVE" "INHOUSE_SIMULIVE" "HYBRID_SIMULIVE" "IN_PERSON_HYBRID"
|
(EventCreationSourceEnum (string or null)) or (NullEnum (any or null)) | |
| user_intent | string Enum: "user_delete" "look_and_feel_update" "registration_page_update"
|
| cvent_event_id | string or null [ 1 .. 255 ] characters |
| cvent_environment | string or null [ 1 .. 255 ] characters |
| created_at | string or null <date-time> |
| discussions_chat_disabled | boolean |
| discussion_room_tab_title | string or null <= 255 characters |
| show_booths | boolean Responsible for showing booths on registration app |
| booth_chat_disabled | boolean |
| booth_tab_title | string or null <= 255 characters |
| booth_tab_title_2 | string or null <= 255 characters |
| show_attendees | boolean Determines if People tab should be visible in event app |
| p2p_chat_disabled | boolean Determines if Direct Messages should be disabled in Event Chat |
| floating_emoji_reactions_enabled | boolean Floating emoji reactions should be enabled in event app |
| event_catch_me_up_enabled | boolean or null Determines if Catch Me Up feature should be enabled in event app |
| show_attendee_profiles | boolean Determines if clicking on attendee name should be allowed to view their profile |
| people_tab_title | string or null <= 255 characters |
| speaker_tab_visible | boolean |
| speaker_tab_title | string or null <= 255 characters Alternative text for default text of Speakers tab (GS-3869) |
| public_chat_disabled | boolean |
| thread_chat_disabled | boolean Disables threaded chat conversations |
| gifs_enabled | boolean Decides whether GIF support is enabled for event |
| is_text_qna_moderated | boolean |
| have_text_qna | boolean or null |
| have_video_qna | boolean or null |
| enable_live_captions | boolean enables the generation of captions in recorder |
| enable_live_captions_translations | boolean enables the generation of translated captions in recorder |
| email_alias_name | string or null <= 255 characters |
| demo_request_message | string non-empty |
| broadcast_chat_disabled | boolean |
| anonymous_qna_enabled | boolean Decide where attendees can ask questions anonymously in an event |
| show_answerers_identity | boolean Decide whether to show answerers identity in QnA |
| textqna_answerers_alias | string or null Decide whether to show answerers alias in QnA |
| is_title_visible | boolean |
| is_date_visible | boolean |
| is_logo_visible | boolean |
| disable_enter_event_button | boolean |
| enable_tech_check | boolean |
| show_onboarding | boolean |
| logo_url | string or null <uri> [ 1 .. 1024 ] characters |
| favicon | string or null <uri> [ 1 .. 1024 ] characters |
| show_discussion_rooms | boolean Responsible for showing discussion rooms on events app |
| title | string [ 1 .. 255 ] characters |
| description | string or null |
| theme_obj | any |
| default_language | string [ 1 .. 6 ] characters field to select the language for an event |
| enable_booth_tiers | boolean Decides whether organizer enables the booth tiers for event |
| social_media_thumbnail | string or null <uri> <= 1024 characters Thumbnail URL to display if registration pages are shared on social websites |
| groups_enabled | boolean Are groups enabled? |
| show_ticker | boolean Is ticker published? |
| show_speakers_reg_page | boolean If False, speaker section on registration page will be hidden |
| hide_event_agenda | boolean Agenda will not be displayed on Event Splash page if this is true (GS-3780) |
| enable_speaker_tech_check | boolean |
| enable_goldbot | boolean |
| demo_request_title | string [ 1 .. 128 ] characters |
| demo_request_button_text | string [ 1 .. 127 ] characters |
| demo_link_enabled | boolean |
| demo_requests_enabled | boolean |
| show_booth_rooms | boolean Responsible for showing rooms in booths on events app |
| show_event_booths | boolean Responsible for showing booths on events app |
| show_registration_share | boolean |
| show_registration_page | boolean |
| show_banner_gradient | boolean |
| show_agenda | boolean |
| have_broadcasts | boolean or null |
| have_discussions | boolean or null |
| have_resources | boolean or null |
| banner_url | string or null <uri> [ 1 .. 1024 ] characters |
| landing_image_url | string or null <uri> [ 1 .. 1024 ] characters |
| theme_layout | string or null <= 63 characters |
| registration_page_title | string or null <= 255 characters |
| show_people_tab_speakers | boolean Decides if people tab is enabled for speakers/organizers |
| registration_page_no_agenda | boolean |
| event_location_in_email | string or null Event location to be shown in email |
| email_body_text | string or null Email body text that can act as description for the event calendar invite |
| subject_in_email | string or null <= 255 characters Subject to be shown in calendar invite |
| assign_speaker_qna | boolean Flag to indicate if speaker can assign questions to other speakers |
| on_demand_demo_link_enabled | boolean Flag to indicate if on_demand demo link is enabled |
| enable_full_hd | boolean Flag to decide whether 1080p streaming will be available |
| speaker_stage_mode | string Enum: "INVITE_SPEAKER" "PUSH_SPEAKER" Decides whether speakers will be asked to come on stage or will be pushed to stage
|
| microphone_control_mode | string Enum: "ASK_TO_UNMUTE" "DIRECT_UNMUTE" Decides whether producers can ask speakers to unmute or speakers can forcefully unmute other speakers
|
(DemoRequestSubmitTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) ONE_CLICK: Attendees see immediate confirmation for demo request. TWO_STEP: Shows confirmation message before sending demo request.
| |
| demo_request_consent_title | string or null <= 255 characters Title of consent dialog for two-step demo request |
| demo_request_disclosure_text | string or null Disclosure text shown in two-step demo request confirmation |
| use_sso_for_events_app | boolean Whether to use SSO login links instead of the magic links on the reminder emails and the calender invite link |
| ai_generated_builder_json_metadata | any or null Metadata related to builder JSON generated by AI, like variation saved |
| short_name | string or null [ 1 .. 63 ] characters |
| responsive | boolean |
| location | string or null Physical Location of the Event to be shown in Hybrid Events |
| registration_limit | integer or null [ -2147483648 .. 2147483647 ] Adds a limit on the number of registration for a particular event |
| registration_support_mail | string or null <email> [ 1 .. 254 ] characters |
| start_time | string <date-time> |
| end_time | string <date-time> |
(InviteTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| cta_link | string or null <= 1024 characters |
| cta_title | string or null <= 63 characters |
| landing_design | integer or null [ -2147483648 .. 2147483647 ] |
| currency | string or null <= 63 characters |
| price | number or null <double> |
| paid | boolean or null |
| show_event_type | boolean |
| show_user_email_on_modals | boolean |
| magic_link_enabled | boolean |
| record_broadcasts | boolean |
| record_discussion_rooms | boolean |
| show_email_onboarding | boolean To decide if on-boarding ui should be shown or not |
| tab_descriptions | any |
| video_quality | string or null <= 15 characters |
| room_video_quality | string or null <= 15 characters |
| calendar_unique_key | string or null <= 31 characters |
| calendar_id | string or null <= 31 characters |
| mmid | string [ 1 .. 26 ] characters |
| meta_tag | any |
| main_app_form_fields | any |
| is_public | boolean |
| has_pre_event_mode | boolean |
| form_fields | any |
| hubspot_form_id | string or null <= 63 characters |
| salesforce_campaign_id | string or null <= 63 characters |
| marketo_campaign_id | string or null <= 63 characters |
| slack_channel_id | string or null <= 63 characters |
| slack_plus_salesforce_channel_id | string or null <= 63 characters |
| wistia_project_id | string or null <= 63 characters |
| hubspot_status | boolean |
| marketo_status | boolean |
| salesforce_status | boolean |
| pardot_status | boolean Pardot is enabled at event level or not. |
| eloqua_status | boolean Eloqua is enabled at event level or not. |
| hubspot_config | any or null |
| marketo_config | any or null |
| salesforce_config | any or null |
| integration_errors | any or null Stores the errors related to integrations |
| integration_config_updated | any or null Stores the config updated information related to integrations |
| hubspot_settings | any or null |
| marketo_settings | any or null |
| salesforce_settings | any or null |
| eloqua_settings | any or null Store the eloqua activites settings |
| pardot_list | any or null list of json object which contain info related to pardot list ID. |
| form_id_list | Array of strings[ items [ 1 .. 31 ] characters ] |
| mail_reminder_intervals | Array of integers[ items [ -2147483648 .. 2147483647 ] ] |
| is_active | boolean |
| preview_image_url | string or null <uri> [ 1 .. 1024 ] characters |
| roll_video_url | string or null <= 1024 characters |
| demo_link | string or null <= 1024 characters |
| video_cdn_enabled | boolean |
| internal_name | string or null <= 255 characters Internal name for the event, visible only to organizers |
| enabled_email_recepient | boolean |
| email_calendar | boolean |
| is_onsite | boolean Denote whether an event is an onsite, was created for field-drive, can be deprecated shortly |
| allow_in_person_check_in | boolean Decides whether in-person check-ins are allowed via 3rd party systems like Validar for hybrid events |
| drift_bot_enabled | boolean |
| drift_landing_enabled | boolean |
| drift_landing_url | string or null <uri> [ 1 .. 1024 ] characters |
| drift_landing_as_default | boolean |
| drift_tab_name | string [ 1 .. 10 ] characters |
(MobileLinkTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| mobile_link_url | string or null <= 1024 characters |
| post_registration_conditions | any |
| enable_hls_captions | boolean enables the generation of captioned hls streams |
| is_test | boolean |
| use_flatfile | boolean flag to decide if flatfile embedded form should be used |
| is_postmark | boolean flag to decide if emails are sent using postmark(True)/SES(false) |
| analytics_script_ran_successfully | boolean flag to check if analytic script ran successfully |
| broadcast_filler_state | string (BroadcastFillerStateEnum) Enum: "PROCESSING" "STOPPED" "ERRORED"
|
| allow_sponsor_access | boolean |
| notify_salesforce_owner_enabled | boolean Points to notify button of slack + salesforce solution instance for an event in admin panel |
| validar_leaderboard_url | string or null <uri> [ 1 .. 1024 ] characters Points to a validar leaderboard url for an event |
| validar_guid | string or null [ 1 .. 255 ] characters A field that maps goldcast's event with validar's event (eventGuid) |
| hidden_agenda_text | string or null [ 1 .. 255 ] characters Text to be shown if agenda is hidden in event splash page. Null will be handled as default in events app. (GS-3780) |
| member_level_magic_links | boolean If True, magic links for this event are event user level, otherwise - user level |
| ticker_text | string or null Ticker message |
| parent | string or null <uuid> Parent event id if duplicated |
| tickets_enabled | boolean Are tickets enabled? |
| vivenu_event_id | string or null [ 1 .. 24 ] characters One-One mapping of this Event with Vivenu Event. |
| self_serve_groups_enabled | boolean Is self serve groups UI enabled? |
| is_auto_redirections_enabled | boolean Enable Auto Redirection of Attendees in Event |
| recorder_event_app_domain | string or null <uri> [ 1 .. 200 ] characters Event app domain for recorder,if left null will go to hardcoded default! |
| is_available_on_demand | boolean Allows organizers to set an event to be delivered on-demand 24 hrs after event ends. Needs to be set 1 hr before event starts along with record_broadcasts and record_discussion_groups. |
| on_demand_mode | boolean Signifies that the event is now in on-demand serving mode. Will be set automatically by backend once all the recording assets are available after 24hrs have passed event's end time |
| magic_link_ttl_mins | integer or null [ -2147483648 .. 2147483647 ] Magic Link expiry duration in minutes |
| tracking_configs | any or null Contains all the tracking configurations required for registration pages like custom script tags etc |
| builder_html | string or null <= 255 characters HTML file path to be used build the registration page |
| builder_raw_json | string or null <= 255 characters Raw JSON file path to be used build the registration page |
| regpage_html_staging | string or null <= 255 characters Staging HTML file path to be used build the registration page |
| primary_booth_tier_texts | any Contains text mapping for each booth tier which will be shown in frontend |
| secondary_booth_tier_texts | any Contains text mapping for each secondary booth tier which will be shown in frontend |
| internal_session_checkin | boolean Flag for internal session checkin |
| scalability_flags | any This field will be used for Frontend to store key value configs to decide certain things to be toggled on/off mainly related to scale |
| channel_sync_triggered | boolean This field will be used to initiate broadcast channel sync via cron flow, event with this flag set means that this event had already synced its broadcast channel previously |
| custom_domain | string or null <= 255 characters Custom domain for the event |
| force_use_inhouse_simulive_flow | boolean This field will be used to force the use of INHOUSE_SIMULIVE flow for SIMULIVE type broadcasts. Changing this field should do a realtime switch to the old SIMULIVE flows for an event. This field is only to be used while production testing of INHOUSE_SIMULIVE. For prod release of the feature we will migrate all existing SIMULIVE broadcasts in the system to the INHOUSE_SIMULIVE flow. |
| reg_page_builder_type | string Enum: "default" "grapejs" "newbuilder" This field will be used to decided registration page builder with default value as null. This field also depends on core_organization.enable_reg_page_builder if this flag is true value of this field will be newbuilder else it will be null during event creation time
|
| registration_app_domain | string or null <uri> <= 1024 characters Registration app domain for the event |
| on_demand_app_url | string or null <uri> <= 1024 characters On-demand app url for the event |
| use_mm_sockets | boolean Used by frontend to decided whether they want to consume sockets coming from mattermost |
| manual_redirection_enabled | boolean Flag to indicate if session redirection in the event will be manual or automatic |
| can_speaker_toggle_session_liveness | boolean Flag to indicate if manual session redirection can be done by speakers |
| host_type | string Enum: "Hybrid" "Virtual" "In_Person" This field will be used to decide the host type of the event
|
| waitlist_enabled | boolean Whether to use waitlist feature or not |
| use_new_stage_controls | boolean Flag to indicate new stage controls to be used on event app |
| sync_status | string Enum: "IDLE" "IN_PROGRESS" "FAILED" Sync status for child event of repeating event
|
| sync_id | string or null <uuid> Sync id to identify the sync process |
| ondemand_builder_config | any or null Stores ondemand page builder config |
| ondemand_embed_config | any or null Stores ondemand embed builder config |
| supported_captions_languages | Array of strings or null (SupportedCaptionsLanguagesEnum) Enum: "en" "es" "zh" "ja" "ko" "de" "it" "fr" "nl" "pt" "pl" "ru" "tr" "th" "vi" "hr" "zh-TW" "es-MX" "da" "sv" "no" "fi" "hu" "cs" "ar" Stores the languages for which captions are supported |
| mm_session_token_extending_time | string or null <date-time> Stores the time when mm token for all users was extended |
| is_new_entry_experience_enabled | boolean Flag to indicate if new event entry experience is enabled |
| is_local_recording | boolean whether to record the broadcast locally |
| is_record_now | boolean Indicates if the recording event is record now or record later. |
(EventEndStatusEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) Status indicating how the event ended
| |
| event_ended_at | string or null <date-time> Timestamp when the event was ended |
| locale | string Enum: "zh-CN" "zh-TW" "en-US" "en-GB" "en-AU" "en-IN" "de-DE" "ja-JA" "es-ES" "ko-KR" "fr-FR" "fr-CA" "nl-NL" "pt-PT" "tr-TR" "ru-RU" "it-IT" "th-TH" "vi-VN" "hr-HR" "pl-PL" Locale string (e.g., en-US, en-GB, fr-FR) for event-specific formatting
|
| enable_content_processing | boolean or null Indicates whether content lab processing pipeline should be triggered for event recording or not |
| use_teleprompter | boolean Indicates whether teleprompter should be used for event or not |
| is_ai_insights_enabled | boolean Indicates whether ai insights should be used for event or not |
| chat_visibilty | string (ChatVisibiltyEnum) Enum: "PUBLIC" "PRIVATE" "OFF"
|
| created_by | string or null <uuid> The user that created this entry |
| updated_by | string or null <uuid> The user that created updated this entry |
| marketing_tags | string or null <uuid> |
| organization | string <uuid> |
| registration_form | string or null <uuid> A 1(event):1(form) mapping to render the FormIo form |
| registration_page | string or null <uuid> maps the organization level registration template to an event |
| owner | string <uuid> |
| stage_roll_video_asset | string or null <uuid> |
| filler_slide | string or null <uuid> Filler slide from library to be used for this event |
| studio_event_template | string or null <uuid> Studio template used to create this event |
| series | string or null <uuid> |
| workspace | string or null <uuid> |
{- "timezone": "string",
- "csv_data": "string",
- "track_order": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "is_single_session": false,
- "event_tags": {
- "entity_tags": [
- {
- "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
- "entity_type": "Event",
- "tag": "ac5f6b7f-bb01-4c1e-a5c0-7a9f62d81c22"
}
]
}, - "event_type": "Conference",
- "broadcast_type": "LIVE_HYBRID",
- "event_creation_source": "goldcast",
- "user_intent": "user_delete",
- "cvent_event_id": "string",
- "cvent_environment": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "discussions_chat_disabled": true,
- "discussion_room_tab_title": "string",
- "show_booths": true,
- "booth_chat_disabled": true,
- "booth_tab_title": "string",
- "booth_tab_title_2": "string",
- "show_attendees": true,
- "p2p_chat_disabled": true,
- "floating_emoji_reactions_enabled": true,
- "event_catch_me_up_enabled": true,
- "show_attendee_profiles": true,
- "people_tab_title": "string",
- "speaker_tab_visible": true,
- "speaker_tab_title": "string",
- "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "gifs_enabled": true,
- "is_text_qna_moderated": true,
- "have_text_qna": true,
- "have_video_qna": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "email_alias_name": "string",
- "demo_request_message": "string",
- "broadcast_chat_disabled": true,
- "anonymous_qna_enabled": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string",
- "is_title_visible": true,
- "is_date_visible": true,
- "is_logo_visible": true,
- "disable_enter_event_button": true,
- "enable_tech_check": true,
- "show_onboarding": true,
- "show_discussion_rooms": true,
- "title": "string",
- "description": "string",
- "theme_obj": null,
- "default_language": "string",
- "enable_booth_tiers": true,
- "groups_enabled": true,
- "show_ticker": true,
- "show_speakers_reg_page": true,
- "hide_event_agenda": true,
- "enable_speaker_tech_check": true,
- "enable_goldbot": true,
- "demo_request_title": "string",
- "demo_request_button_text": "string",
- "demo_link_enabled": true,
- "demo_requests_enabled": true,
- "show_booth_rooms": true,
- "show_event_booths": true,
- "show_registration_share": true,
- "show_registration_page": true,
- "show_banner_gradient": true,
- "show_agenda": true,
- "have_broadcasts": true,
- "have_discussions": true,
- "have_resources": true,
- "theme_layout": "string",
- "registration_page_title": "string",
- "show_people_tab_speakers": true,
- "registration_page_no_agenda": true,
- "event_location_in_email": "string",
- "email_body_text": "string",
- "subject_in_email": "string",
- "assign_speaker_qna": true,
- "on_demand_demo_link_enabled": true,
- "enable_full_hd": true,
- "speaker_stage_mode": "INVITE_SPEAKER",
- "microphone_control_mode": "ASK_TO_UNMUTE",
- "demo_request_submit_type": "ONE_CLICK",
- "demo_request_consent_title": "string",
- "demo_request_disclosure_text": "string",
- "use_sso_for_events_app": true,
- "ai_generated_builder_json_metadata": null,
- "short_name": "string",
- "responsive": true,
- "location": "string",
- "registration_limit": -2147483648,
- "registration_support_mail": "user@example.com",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "invite_type": "FULL_EVENT_INVITE",
- "cta_link": "string",
- "cta_title": "string",
- "landing_design": -2147483648,
- "currency": "string",
- "price": 0.1,
- "paid": true,
- "show_event_type": true,
- "show_user_email_on_modals": true,
- "magic_link_enabled": true,
- "record_broadcasts": true,
- "record_discussion_rooms": true,
- "show_email_onboarding": true,
- "tab_descriptions": null,
- "video_quality": "string",
- "room_video_quality": "string",
- "calendar_unique_key": "string",
- "calendar_id": "string",
- "mmid": "string",
- "meta_tag": null,
- "main_app_form_fields": null,
- "is_public": true,
- "has_pre_event_mode": true,
- "form_fields": null,
- "hubspot_form_id": "string",
- "salesforce_campaign_id": "string",
- "marketo_campaign_id": "string",
- "slack_channel_id": "string",
- "slack_plus_salesforce_channel_id": "string",
- "wistia_project_id": "string",
- "hubspot_status": true,
- "marketo_status": true,
- "salesforce_status": true,
- "pardot_status": true,
- "eloqua_status": true,
- "hubspot_config": null,
- "marketo_config": null,
- "salesforce_config": null,
- "integration_errors": null,
- "integration_config_updated": null,
- "hubspot_settings": null,
- "marketo_settings": null,
- "salesforce_settings": null,
- "eloqua_settings": null,
- "pardot_list": null,
- "form_id_list": [
- "string"
], - "mail_reminder_intervals": [
- -2147483648
], - "is_active": true,
- "roll_video_url": "string",
- "demo_link": "string",
- "video_cdn_enabled": true,
- "internal_name": "string",
- "enabled_email_recepient": true,
- "email_calendar": true,
- "is_onsite": true,
- "allow_in_person_check_in": true,
- "drift_bot_enabled": true,
- "drift_landing_enabled": true,
- "drift_landing_as_default": true,
- "drift_tab_name": "string",
- "mobile_link_type": "Youtube",
- "mobile_link_url": "string",
- "post_registration_conditions": null,
- "enable_hls_captions": true,
- "is_test": true,
- "use_flatfile": true,
- "is_postmark": true,
- "analytics_script_ran_successfully": true,
- "broadcast_filler_state": "PROCESSING",
- "allow_sponsor_access": true,
- "notify_salesforce_owner_enabled": true,
- "validar_guid": "string",
- "hidden_agenda_text": "string",
- "member_level_magic_links": true,
- "ticker_text": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "tickets_enabled": true,
- "vivenu_event_id": "string",
- "self_serve_groups_enabled": true,
- "is_auto_redirections_enabled": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "magic_link_ttl_mins": -2147483648,
- "tracking_configs": null,
- "builder_html": "string",
- "builder_raw_json": "string",
- "regpage_html_staging": "string",
- "primary_booth_tier_texts": null,
- "secondary_booth_tier_texts": null,
- "internal_session_checkin": true,
- "scalability_flags": null,
- "channel_sync_triggered": true,
- "custom_domain": "string",
- "force_use_inhouse_simulive_flow": true,
- "reg_page_builder_type": "default",
- "use_mm_sockets": true,
- "manual_redirection_enabled": true,
- "can_speaker_toggle_session_liveness": true,
- "host_type": "Hybrid",
- "waitlist_enabled": true,
- "use_new_stage_controls": true,
- "sync_status": "IDLE",
- "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",
- "ondemand_builder_config": null,
- "ondemand_embed_config": null,
- "supported_captions_languages": [
- "en"
], - "mm_session_token_extending_time": "2019-08-24T14:15:22Z",
- "is_new_entry_experience_enabled": true,
- "is_local_recording": true,
- "is_record_now": true,
- "event_end_status": "NONE",
- "event_ended_at": "2019-08-24T14:15:22Z",
- "locale": "zh-CN",
- "enable_content_processing": true,
- "use_teleprompter": true,
- "is_ai_insights_enabled": true,
- "chat_visibilty": "PUBLIC",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "registration_form": "d2b4ac8a-f10a-45f2-a0f3-4db879f54214",
- "registration_page": "df58ed99-8981-464a-9a11-b21b377ec797",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
- "stage_roll_video_asset": "2195df49-a488-42e9-8915-7e8c84d37d54",
- "filler_slide": "deb19fea-dd3e-4c52-8ee1-82a109b4a929",
- "studio_event_template": "dc8f5231-81e6-45a0-8f9d-2e0c29a57e9e",
- "series": "41145f9c-df72-4764-8701-78239ee0e3bd",
- "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timezone": "string",
- "csv_data": "string",
- "manual_breakout": true,
- "supported_languages": [
- {
- "code": "string",
- "name": "string",
- "native_name": "string"
}
], - "events_app_languages": [
- {
- "code": "string",
- "name": "string",
- "native_name": "string"
}
], - "vivenu_event_url": "string",
- "is_single_session": false,
- "created_by_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "updated_by_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "splash_tracking_pixel_snippet": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "head_section_script": "string",
- "body_section_script": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom_event_script": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe"
}, - "registrant_count": "string",
- "registration_cta_link": "string",
- "event_type": "Conference",
- "broadcast_type": "LIVE_HYBRID",
- "event_creation_source": "goldcast",
- "metadata": {
- "property1": null,
- "property2": null
}, - "recording_state": "string",
- "registration_form_data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "is_one_click_enabled": true,
- "form_type": "SINGLE_EVENT",
- "is_default": true,
- "is_global_form": true,
- "schema_url": "string",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "cvent_event_id": "string",
- "cvent_environment": "string",
- "series": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "registrant_count": "string",
- "contains_waitlist_event": "string",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "updated_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "upcoming_event_count": "string",
- "attendee_count": "string",
- "registration_form_url": "string",
- "blueprint_event": "string",
- "repeating_event_sync_allowed": true,
- "next_event_generation_time": "string",
- "initial_event_generated": true,
- "tags": "string",
- "registration_form_data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "is_one_click_enabled": true,
- "form_type": "SINGLE_EVENT",
- "is_default": true,
- "is_global_form": true,
- "schema_url": "string",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "builder_html": "string",
- "builder_raw_json": "string",
- "marketo_base_program_id": "string",
- "marketo_program_folder_id": -2147483648,
- "marketo_program_folder_name": "string",
- "marketo_settings": null,
- "marketo_status": true,
- "email_alias_name": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "type": "default",
- "schedule": "string",
- "initial_event_generation_count": 1,
- "total_event_threshold": 1,
- "end_date_threshold": "2019-08-24",
- "schedule_status": "LIVE",
- "frequency": 1,
- "unit": "days",
- "sync_status": "IDLE",
- "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "registration_form": "d2b4ac8a-f10a-45f2-a0f3-4db879f54214",
- "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89"
}, - "tags": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "workspace": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "icon": "string",
- "color": "string"
}, - "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "discussions_chat_disabled": true,
- "discussion_room_tab_title": "string",
- "show_booths": true,
- "booth_chat_disabled": true,
- "booth_tab_title": "string",
- "booth_tab_title_2": "string",
- "show_attendees": true,
- "p2p_chat_disabled": true,
- "floating_emoji_reactions_enabled": true,
- "event_catch_me_up_enabled": true,
- "show_attendee_profiles": true,
- "people_tab_title": "string",
- "speaker_tab_visible": true,
- "speaker_tab_title": "string",
- "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "gifs_enabled": true,
- "is_text_qna_moderated": true,
- "have_text_qna": true,
- "have_video_qna": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "email_alias_name": "string",
- "demo_request_message": "string",
- "broadcast_chat_disabled": true,
- "anonymous_qna_enabled": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string",
- "is_title_visible": true,
- "is_date_visible": true,
- "is_logo_visible": true,
- "disable_enter_event_button": true,
- "enable_tech_check": true,
- "show_onboarding": true,
- "show_discussion_rooms": true,
- "title": "string",
- "description": "string",
- "theme_obj": null,
- "default_language": "string",
- "enable_booth_tiers": true,
- "groups_enabled": true,
- "show_ticker": true,
- "show_speakers_reg_page": true,
- "hide_event_agenda": true,
- "default_language_dropdown_enabled": true,
- "enable_speaker_tech_check": true,
- "enable_goldbot": true,
- "demo_request_title": "string",
- "demo_request_button_text": "string",
- "demo_link_enabled": true,
- "demo_requests_enabled": true,
- "show_booth_rooms": true,
- "show_event_booths": true,
- "show_registration_share": true,
- "show_registration_page": true,
- "show_banner_gradient": true,
- "show_agenda": true,
- "have_broadcasts": true,
- "have_discussions": true,
- "have_resources": true,
- "theme_layout": "string",
- "registration_page_title": "string",
- "show_people_tab_speakers": true,
- "registration_page_no_agenda": true,
- "event_location_in_email": "string",
- "email_body_text": "string",
- "subject_in_email": "string",
- "assign_speaker_qna": true,
- "on_demand_demo_link_enabled": true,
- "enable_full_hd": true,
- "speaker_stage_mode": "INVITE_SPEAKER",
- "microphone_control_mode": "ASK_TO_UNMUTE",
- "demo_request_submit_type": "ONE_CLICK",
- "demo_request_consent_title": "string",
- "demo_request_disclosure_text": "string",
- "use_sso_for_events_app": true,
- "ai_generated_builder_json_metadata": null,
- "short_id": 0,
- "short_name": "string",
- "responsive": true,
- "location": "string",
- "registration_limit": -2147483648,
- "registration_support_mail": "user@example.com",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "invite_type": "FULL_EVENT_INVITE",
- "cta_link": "string",
- "cta_title": "string",
- "landing_design": -2147483648,
- "currency": "string",
- "price": 0.1,
- "paid": true,
- "show_event_type": true,
- "show_user_email_on_modals": true,
- "magic_link_enabled": true,
- "record_broadcasts": true,
- "record_discussion_rooms": true,
- "show_email_onboarding": true,
- "tab_descriptions": null,
- "video_quality": "string",
- "room_video_quality": "string",
- "calendar_unique_key": "string",
- "calendar_id": "string",
- "mmid": "string",
- "meta_tag": null,
- "main_app_form_fields": null,
- "is_public": true,
- "has_pre_event_mode": true,
- "form_fields": null,
- "hubspot_form_id": "string",
- "salesforce_campaign_id": "string",
- "marketo_campaign_id": "string",
- "slack_channel_id": "string",
- "slack_plus_salesforce_channel_id": "string",
- "wistia_project_id": "string",
- "hubspot_status": true,
- "marketo_status": true,
- "salesforce_status": true,
- "pardot_status": true,
- "eloqua_status": true,
- "hubspot_config": null,
- "marketo_config": null,
- "salesforce_config": null,
- "integration_errors": null,
- "integration_config_updated": null,
- "hubspot_settings": null,
- "marketo_settings": null,
- "salesforce_settings": null,
- "eloqua_settings": null,
- "pardot_list": null,
- "form_id_list": [
- "string"
], - "mail_reminder_intervals": [
- -2147483648
], - "is_active": true,
- "is_hybrid": true,
- "roll_video_url": "string",
- "demo_link": "string",
- "video_cdn_enabled": true,
- "internal_name": "string",
- "enabled_email_recepient": true,
- "email_calendar": true,
- "is_onsite": true,
- "allow_in_person_check_in": true,
- "drift_bot_enabled": true,
- "drift_landing_enabled": true,
- "drift_landing_as_default": true,
- "drift_tab_name": "string",
- "mobile_link_type": "Youtube",
- "mobile_link_url": "string",
- "post_registration_conditions": null,
- "enable_hls_captions": true,
- "is_test": true,
- "use_flatfile": true,
- "is_postmark": true,
- "analytics_script_ran_successfully": true,
- "broadcast_filler_image_s3_path": "string",
- "broadcast_filler_video_s3_path": "string",
- "broadcast_filler_state": "PROCESSING",
- "allow_sponsor_access": true,
- "notify_salesforce_owner_enabled": true,
- "validar_guid": "string",
- "hidden_agenda_text": "string",
- "member_level_magic_links": true,
- "ticker_text": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "tickets_enabled": true,
- "vivenu_event_id": "string",
- "self_serve_groups_enabled": true,
- "is_auto_redirections_enabled": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "magic_link_ttl_mins": -2147483648,
- "tracking_configs": null,
- "builder_html": "string",
- "builder_raw_json": "string",
- "regpage_html_staging": "string",
- "primary_booth_tier_texts": null,
- "secondary_booth_tier_texts": null,
- "internal_session_checkin": true,
- "scalability_flags": null,
- "channel_sync_triggered": true,
- "custom_domain": "string",
- "force_use_inhouse_simulive_flow": true,
- "reg_page_builder_type": "default",
- "use_mm_sockets": true,
- "manual_redirection_enabled": true,
- "can_speaker_toggle_session_liveness": true,
- "host_type": "Hybrid",
- "waitlist_enabled": true,
- "use_new_stage_controls": true,
- "is_blueprint": true,
- "sync_status": "IDLE",
- "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",
- "ondemand_builder_config": null,
- "ondemand_embed_config": null,
- "supported_captions_languages": [
- "en"
], - "mm_session_token_extending_time": "2019-08-24T14:15:22Z",
- "is_new_entry_experience_enabled": true,
- "is_local_recording": true,
- "is_record_now": true,
- "event_end_status": "NONE",
- "event_ended_at": "2019-08-24T14:15:22Z",
- "locale": "zh-CN",
- "enable_content_processing": true,
- "use_teleprompter": true,
- "is_ai_insights_enabled": true,
- "chat_visibilty": "PUBLIC",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "registration_form": "d2b4ac8a-f10a-45f2-a0f3-4db879f54214",
- "registration_page": "df58ed99-8981-464a-9a11-b21b377ec797",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
- "stage_roll_video_asset": "2195df49-a488-42e9-8915-7e8c84d37d54",
- "filler_slide": "deb19fea-dd3e-4c52-8ee1-82a109b4a929",
- "studio_event_template": "dc8f5231-81e6-45a0-8f9d-2e0c29a57e9e"
}| id required | string <uuid> A UUID string identifying this event. |
{- "broadcast": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "medialive_rtmp_input_details": {
- "output_url": "string"
}, - "video_assets": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "updated_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
- "urls": {
- "hls": "string"
}, - "video_usage_count": 0,
- "fallback_hls_path": "string",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "uploaded": true,
- "duration": -2147483648,
- "thumbnail": "string",
- "asset_type": "VIDEO",
- "creation_type": "UPLOADED",
- "source": "EVENT_RECORDING",
- "transcode_status": "SUBMITTED",
- "slide_conversion_status": "COMPLETE",
- "transcoder_errors": [
- "GENERIC_ERROR"
], - "transcoder_warnings": [
- "GENERIC_WARNING"
], - "transcript_path": null,
- "transcoder_type": "MEDIACONVERT",
- "transcode_finish_time": "2019-08-24T14:15:22Z",
- "path": "string",
- "onedrive_upload_state": "PROGRESSING",
- "is_animations_enabled": true,
- "onedrive_file_id": "string",
- "hls_path": "string",
- "client_hls_path": "string",
- "source_language": "no",
- "metadata": null,
- "error_message": "string",
- "playback_audio_s3_key": "string",
- "playback_audio_s3_bucket": "string",
- "slide_count": -2147483648,
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}
], - "slide_assets": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "updated_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
- "urls": {
- "hls": "string"
}, - "video_usage_count": 0,
- "fallback_hls_path": "string",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "uploaded": true,
- "duration": -2147483648,
- "thumbnail": "string",
- "asset_type": "VIDEO",
- "creation_type": "UPLOADED",
- "source": "EVENT_RECORDING",
- "transcode_status": "SUBMITTED",
- "slide_conversion_status": "COMPLETE",
- "transcoder_errors": [
- "GENERIC_ERROR"
], - "transcoder_warnings": [
- "GENERIC_WARNING"
], - "transcript_path": null,
- "transcoder_type": "MEDIACONVERT",
- "transcode_finish_time": "2019-08-24T14:15:22Z",
- "path": "string",
- "onedrive_upload_state": "PROGRESSING",
- "is_animations_enabled": true,
- "onedrive_file_id": "string",
- "hls_path": "string",
- "client_hls_path": "string",
- "source_language": "no",
- "metadata": null,
- "error_message": "string",
- "playback_audio_s3_key": "string",
- "playback_audio_s3_bucket": "string",
- "slide_count": -2147483648,
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}
], - "on_demand_asset": "string",
- "surveys": "string",
- "expected_end_time": "2019-08-24T14:15:22Z",
- "allowed_end_time": "2019-08-24T14:15:22Z",
- "allowed_start_time": "2019-08-24T14:15:22Z",
- "manual_redirection_enabled": "string",
- "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "video_qna_requests": [
- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "status": "OPEN",
- "broadcast": "efb664fb-9d6b-42d7-89a9-e3409eec5bf2",
- "user": "76f62a58-5404-486d-9afc-07bded328704"
}
], - "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "description": "string",
- "location": "string",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z",
- "have_video_qna": true,
- "have_text_qna": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "have_polls": true,
- "is_on_demand": true,
- "is_live": true,
- "recording": null,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "mmid": "string",
- "poll_channel_mmid": "string",
- "video_qna_channel_mmid": "string",
- "text_qna_channel_mmid": "string",
- "speaker_chat_mmid": "string",
- "live_captions_mmid": "string",
- "is_joinable": true,
- "external_stream_url": "string",
- "broadcast_type": "LIVE",
- "simulive_link": "string",
- "is_hybrid_playing_simulive": true,
- "isVbr": true,
- "is_hls_low": true,
- "is_hls_med": true,
- "is_hls_high": true,
- "is_recording": true,
- "latest_recording_timestamp": "string",
- "recording_task_arn": "string",
- "recording_dir_prefix": "string",
- "playback_start_time": "2019-08-24T14:15:22Z",
- "current_playing_slide_number": -2147483648,
- "current_playing_step_number": -2147483648,
- "slide_state_version": -9223372036854776000,
- "screen_share_layout": "FLOATING",
- "sort_priority": -2147483648,
- "medialive_channel_state": "CREATING",
- "wordly_session_id": "string",
- "wordly_session_key": "string",
- "stage_logo_spec": null,
- "lower_third_spec": null,
- "validar_guid": "string",
- "simulive_test_run_end_time": "2019-08-24T14:15:22Z",
- "round_videos": true,
- "show_active_speaker_only": true,
- "is_available_on_demand": true,
- "overlay_text": "string",
- "show_overlay": true,
- "ticker_text": "string",
- "show_ticker": true,
- "slido_poll_embed_url": "string",
- "slido_qa_embed_url": "string",
- "content_repurposing_enabled": true,
- "on_demand_recording_published": true,
- "ppt_task_launch_time": "2019-08-24T14:15:22Z",
- "use_medialive_channel": true,
- "slide_asset_viewer_state": "NOT_INITIATED",
- "run_of_show_config": null,
- "on_demand_run_of_show_config": null,
- "is_automated_run_of_show": true,
- "recording_studio_state": "NOT_INITIALIZED",
- "session_language": "string",
- "local_recording_fps": -2147483648,
- "use_pure_cloud_recording": true,
- "enable_live_run_of_show": true,
- "layout_settings": null,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "current_playing_video_asset": "4b45101d-061c-40ce-8e5b-239db1b819e1",
- "current_playing_slide_asset": "8f60b14a-43b8-4a76-a448-5777c97995c0",
- "sign_language_translator_user_id": "7df3698b-558d-424f-a5ec-002e323b163e",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "speakers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "staffs": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
], - "items": [
- {
- "id": 0,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "title": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "kind": "break",
- "is_live": true,
- "description": "string",
- "expected_end_time": "2019-08-24T14:15:22Z",
- "allowed_end_time": "2019-08-24T14:15:22Z",
- "allowed_start_time": "2019-08-24T14:15:22Z",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z"
}
]
}| id required | string <uuid> A UUID string identifying this event. |
| fields required | Array of strings (FieldsEnum) Items Enum: "booth" "broadcast" "discussion_group" "event_email_templates" "event_email_config" "items" "resource" "theme" "polls" "track" "medialive_rtmp_inputs" "ticket_type" |
| start_time | string <date-time> |
| title | string non-empty |
| timezone | string non-empty |
| copy_speakers | boolean Default: false |
| series | string <uuid> |
| workspace | string or null <uuid> |
| send_invite_emails_to_speakers | boolean Default: false |
| send_staff_invites | boolean Default: false |
{- "fields": [
- "booth"
], - "start_time": "2019-08-24T14:15:22Z",
- "title": "string",
- "timezone": "string",
- "copy_speakers": false,
- "series": "41145f9c-df72-4764-8701-78239ee0e3bd",
- "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
- "send_invite_emails_to_speakers": false,
- "send_staff_invites": false
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timezone": "string",
- "csv_data": "string",
- "manual_breakout": true,
- "supported_languages": [
- {
- "code": "string",
- "name": "string",
- "native_name": "string"
}
], - "events_app_languages": [
- {
- "code": "string",
- "name": "string",
- "native_name": "string"
}
], - "vivenu_event_url": "string",
- "is_single_session": false,
- "created_by_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "updated_by_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "splash_tracking_pixel_snippet": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "head_section_script": "string",
- "body_section_script": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom_event_script": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe"
}, - "registrant_count": "string",
- "registration_cta_link": "string",
- "event_type": "Conference",
- "broadcast_type": "LIVE_HYBRID",
- "event_creation_source": "goldcast",
- "metadata": {
- "property1": null,
- "property2": null
}, - "recording_state": "string",
- "registration_form_data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "is_one_click_enabled": true,
- "form_type": "SINGLE_EVENT",
- "is_default": true,
- "is_global_form": true,
- "schema_url": "string",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "cvent_event_id": "string",
- "cvent_environment": "string",
- "series": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "registrant_count": "string",
- "contains_waitlist_event": "string",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "updated_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "role": "ORG_ADMIN",
- "profile_picture_url": "string"
}, - "upcoming_event_count": "string",
- "attendee_count": "string",
- "registration_form_url": "string",
- "blueprint_event": "string",
- "repeating_event_sync_allowed": true,
- "next_event_generation_time": "string",
- "initial_event_generated": true,
- "tags": "string",
- "registration_form_data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "is_one_click_enabled": true,
- "form_type": "SINGLE_EVENT",
- "is_default": true,
- "is_global_form": true,
- "schema_url": "string",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "builder_html": "string",
- "builder_raw_json": "string",
- "marketo_base_program_id": "string",
- "marketo_program_folder_id": -2147483648,
- "marketo_program_folder_name": "string",
- "marketo_settings": null,
- "marketo_status": true,
- "email_alias_name": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "type": "default",
- "schedule": "string",
- "initial_event_generation_count": 1,
- "total_event_threshold": 1,
- "end_date_threshold": "2019-08-24",
- "schedule_status": "LIVE",
- "frequency": 1,
- "unit": "days",
- "sync_status": "IDLE",
- "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "registration_form": "d2b4ac8a-f10a-45f2-a0f3-4db879f54214",
- "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89"
}, - "tags": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "workspace": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "icon": "string",
- "color": "string"
}, - "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "discussions_chat_disabled": true,
- "discussion_room_tab_title": "string",
- "show_booths": true,
- "booth_chat_disabled": true,
- "booth_tab_title": "string",
- "booth_tab_title_2": "string",
- "show_attendees": true,
- "p2p_chat_disabled": true,
- "floating_emoji_reactions_enabled": true,
- "event_catch_me_up_enabled": true,
- "show_attendee_profiles": true,
- "people_tab_title": "string",
- "speaker_tab_visible": true,
- "speaker_tab_title": "string",
- "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "gifs_enabled": true,
- "is_text_qna_moderated": true,
- "have_text_qna": true,
- "have_video_qna": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "email_alias_name": "string",
- "demo_request_message": "string",
- "broadcast_chat_disabled": true,
- "anonymous_qna_enabled": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string",
- "is_title_visible": true,
- "is_date_visible": true,
- "is_logo_visible": true,
- "disable_enter_event_button": true,
- "enable_tech_check": true,
- "show_onboarding": true,
- "show_discussion_rooms": true,
- "title": "string",
- "description": "string",
- "theme_obj": null,
- "default_language": "string",
- "enable_booth_tiers": true,
- "groups_enabled": true,
- "show_ticker": true,
- "show_speakers_reg_page": true,
- "hide_event_agenda": true,
- "default_language_dropdown_enabled": true,
- "enable_speaker_tech_check": true,
- "enable_goldbot": true,
- "demo_request_title": "string",
- "demo_request_button_text": "string",
- "demo_link_enabled": true,
- "demo_requests_enabled": true,
- "show_booth_rooms": true,
- "show_event_booths": true,
- "show_registration_share": true,
- "show_registration_page": true,
- "show_banner_gradient": true,
- "show_agenda": true,
- "have_broadcasts": true,
- "have_discussions": true,
- "have_resources": true,
- "theme_layout": "string",
- "registration_page_title": "string",
- "show_people_tab_speakers": true,
- "registration_page_no_agenda": true,
- "event_location_in_email": "string",
- "email_body_text": "string",
- "subject_in_email": "string",
- "assign_speaker_qna": true,
- "on_demand_demo_link_enabled": true,
- "enable_full_hd": true,
- "speaker_stage_mode": "INVITE_SPEAKER",
- "microphone_control_mode": "ASK_TO_UNMUTE",
- "demo_request_submit_type": "ONE_CLICK",
- "demo_request_consent_title": "string",
- "demo_request_disclosure_text": "string",
- "use_sso_for_events_app": true,
- "ai_generated_builder_json_metadata": null,
- "short_id": 0,
- "short_name": "string",
- "responsive": true,
- "location": "string",
- "registration_limit": -2147483648,
- "registration_support_mail": "user@example.com",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "invite_type": "FULL_EVENT_INVITE",
- "cta_link": "string",
- "cta_title": "string",
- "landing_design": -2147483648,
- "currency": "string",
- "price": 0.1,
- "paid": true,
- "show_event_type": true,
- "show_user_email_on_modals": true,
- "magic_link_enabled": true,
- "record_broadcasts": true,
- "record_discussion_rooms": true,
- "show_email_onboarding": true,
- "tab_descriptions": null,
- "video_quality": "string",
- "room_video_quality": "string",
- "calendar_unique_key": "string",
- "calendar_id": "string",
- "mmid": "string",
- "meta_tag": null,
- "main_app_form_fields": null,
- "is_public": true,
- "has_pre_event_mode": true,
- "form_fields": null,
- "hubspot_form_id": "string",
- "salesforce_campaign_id": "string",
- "marketo_campaign_id": "string",
- "slack_channel_id": "string",
- "slack_plus_salesforce_channel_id": "string",
- "wistia_project_id": "string",
- "hubspot_status": true,
- "marketo_status": true,
- "salesforce_status": true,
- "pardot_status": true,
- "eloqua_status": true,
- "hubspot_config": null,
- "marketo_config": null,
- "salesforce_config": null,
- "integration_errors": null,
- "integration_config_updated": null,
- "hubspot_settings": null,
- "marketo_settings": null,
- "salesforce_settings": null,
- "eloqua_settings": null,
- "pardot_list": null,
- "form_id_list": [
- "string"
], - "mail_reminder_intervals": [
- -2147483648
], - "is_active": true,
- "is_hybrid": true,
- "roll_video_url": "string",
- "demo_link": "string",
- "video_cdn_enabled": true,
- "internal_name": "string",
- "enabled_email_recepient": true,
- "email_calendar": true,
- "is_onsite": true,
- "allow_in_person_check_in": true,
- "drift_bot_enabled": true,
- "drift_landing_enabled": true,
- "drift_landing_as_default": true,
- "drift_tab_name": "string",
- "mobile_link_type": "Youtube",
- "mobile_link_url": "string",
- "post_registration_conditions": null,
- "enable_hls_captions": true,
- "is_test": true,
- "use_flatfile": true,
- "is_postmark": true,
- "analytics_script_ran_successfully": true,
- "broadcast_filler_image_s3_path": "string",
- "broadcast_filler_video_s3_path": "string",
- "broadcast_filler_state": "PROCESSING",
- "allow_sponsor_access": true,
- "notify_salesforce_owner_enabled": true,
- "validar_guid": "string",
- "hidden_agenda_text": "string",
- "member_level_magic_links": true,
- "ticker_text": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "tickets_enabled": true,
- "vivenu_event_id": "string",
- "self_serve_groups_enabled": true,
- "is_auto_redirections_enabled": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "magic_link_ttl_mins": -2147483648,
- "tracking_configs": null,
- "builder_html": "string",
- "builder_raw_json": "string",
- "regpage_html_staging": "string",
- "primary_booth_tier_texts": null,
- "secondary_booth_tier_texts": null,
- "internal_session_checkin": true,
- "scalability_flags": null,
- "channel_sync_triggered": true,
- "custom_domain": "string",
- "force_use_inhouse_simulive_flow": true,
- "reg_page_builder_type": "default",
- "use_mm_sockets": true,
- "manual_redirection_enabled": true,
- "can_speaker_toggle_session_liveness": true,
- "host_type": "Hybrid",
- "waitlist_enabled": true,
- "use_new_stage_controls": true,
- "is_blueprint": true,
- "sync_status": "IDLE",
- "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",
- "ondemand_builder_config": null,
- "ondemand_embed_config": null,
- "supported_captions_languages": [
- "en"
], - "mm_session_token_extending_time": "2019-08-24T14:15:22Z",
- "is_new_entry_experience_enabled": true,
- "is_local_recording": true,
- "is_record_now": true,
- "event_end_status": "NONE",
- "event_ended_at": "2019-08-24T14:15:22Z",
- "locale": "zh-CN",
- "enable_content_processing": true,
- "use_teleprompter": true,
- "is_ai_insights_enabled": true,
- "chat_visibilty": "PUBLIC",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "marketing_tags": "1638d6ff-28e6-43fc-9411-1aee3d226d08",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "registration_form": "d2b4ac8a-f10a-45f2-a0f3-4db879f54214",
- "registration_page": "df58ed99-8981-464a-9a11-b21b377ec797",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
- "stage_roll_video_asset": "2195df49-a488-42e9-8915-7e8c84d37d54",
- "filler_slide": "deb19fea-dd3e-4c52-8ee1-82a109b4a929",
- "studio_event_template": "dc8f5231-81e6-45a0-8f9d-2e0c29a57e9e"
}| id required | string <uuid> A UUID string identifying this event. |
| analytics_script_ran_successfully | boolean |
| created_at | string <date-time> |
| created_at_gte | string <date-time> |
| created_at_lte | string <date-time> |
| description | string |
| end_time | string <date-time> |
| end_time_gt | string <date-time> |
| end_time_gte | string <date-time> |
| end_time_lt | string <date-time> |
| end_time_lte | string <date-time> |
| event_type | Array of strings or null Items Enum: "Conference" "Recording" "Webinar" decide the type of an event
|
| have_broadcasts | boolean |
| have_discussions | boolean |
| host_type | string |
| internal_session_checkin | boolean |
| is_onsite | boolean |
| is_test | boolean |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| on_demand_mode | boolean |
| ordering | string Which field to use when ordering the results. |
| organization | string <uuid> |
| search | string |
| series | string <uuid> |
| series_type | string Enum: "default" "repeating" Type of series
|
| short_name | string |
| start_time | string <date-time> |
| start_time_gt | string <date-time> |
| start_time_gte | string <date-time> |
| start_time_lt | string <date-time> |
| start_time_lte | string <date-time> |
| tag | Array of strings |
| title | string |
| updated_at | string <date-time> |
| updated_at_gte | string <date-time> |
| updated_at_lte | string <date-time> |
| user | string |
| user_email | string |
| vivenu_event_id | string |
| workspace | string <uuid> |
| workspace__isnull | boolean |
{- "count": 123,
- "results": [
- {
- "s3_key": "string",
- "signed_get_url": "string",
- "name": "string",
- "descriptor": "string",
- "created_at": "string",
- "expires_in": 0
}
]
}Get event agenda
| event_id required | string <uuid> A UUID string identifying this event. |
{- "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
- "session_name": "string",
- "session_start_time": "string",
- "session_end_time": "string",
- "session_type": "string",
- "session_description": "string",
- "session_location": "string",
- "session_speakers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "title": "string",
- "profile_picture_url": "string",
- "company": "string",
- "description": "string"
}
]
}Get event agenda
| event_id required | string <uuid> A UUID string identifying this event. |
{- "primary_booths": {
- "TIER1": {
- "name": "string",
- "booths": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
}
]
}, - "TIER2": {
- "name": "string",
- "booths": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
}
]
}, - "TIER3": {
- "name": "string",
- "booths": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
}
]
}
}, - "secondary_booths": {
- "TIER1": {
- "name": "string",
- "booths": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
}
]
}, - "TIER2": {
- "name": "string",
- "booths": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
}
]
}, - "TIER3": {
- "name": "string",
- "booths": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
}
]
}
}
}Get event overview
| event_id required | string <uuid> A UUID string identifying this event. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "timezone": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "location": "string",
- "is_on_demand": true,
- "is_test": true,
- "tags": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "host_type": "Hybrid",
- "description": "string",
}Get event speakers
| event_id required | string <uuid> A UUID string identifying this event. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "first_name": "string",
- "last_name": "string",
- "title": "string",
- "profile_picture_url": "string",
- "company": "string",
- "description": "string"
}| event_type | string Enum: "live_and_upcoming" "on_demand" "upcoming" Event type to filter events. If nothing is passed all events will be returned. |
| host_type | string Enum: "Hybrid" "In_Person" "Virtual" Host type to filter events. |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| order_by | string Enum: "-created_at" "-start_time" "-title" "-updated_at" "created_at" "start_time" "title" "updated_at" Ordering parameter. Default is -created_at. |
| organization required | string Organization id to filter events. |
{- "count": 123,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "timezone": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "location": "string",
- "host_type": "Hybrid",
- "description": "string",
- "goldcast_reg_page_link": "string"
}
]
}| event | string <uuid> |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
{- "count": 123,
- "results": [
- {
- "id": 0,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "title": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "kind": "break",
- "is_live": true,
- "description": "string",
- "expected_end_time": "2019-08-24T14:15:22Z",
- "allowed_end_time": "2019-08-24T14:15:22Z",
- "allowed_start_time": "2019-08-24T14:15:22Z",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z"
}
]
}| event required | string <uuid> |
| title required | string [ 1 .. 255 ] characters |
| start_time required | string <date-time> |
| end_time required | string <date-time> |
| kind | string (Kind20fEnum) Enum: "break" "networking" "booth" "room" "booth2"
|
| is_live | boolean |
| description | string or null |
| track | Array of strings <uuid> [ items <uuid > ] |
| live_start_time | string or null <date-time> |
| live_end_time | string or null <date-time> |
{- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "title": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "kind": "break",
- "is_live": true,
- "description": "string",
- "track": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z"
}{- "id": 0,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "title": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "kind": "break",
- "is_live": true,
- "description": "string",
- "expected_end_time": "2019-08-24T14:15:22Z",
- "allowed_end_time": "2019-08-24T14:15:22Z",
- "allowed_start_time": "2019-08-24T14:15:22Z",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z"
}| id required | integer A unique integer value identifying this agenda item. |
{- "id": 0,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "title": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "kind": "break",
- "is_live": true,
- "description": "string",
- "expected_end_time": "2019-08-24T14:15:22Z",
- "allowed_end_time": "2019-08-24T14:15:22Z",
- "allowed_start_time": "2019-08-24T14:15:22Z",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z"
}| id required | integer A unique integer value identifying this agenda item. |
| event required | string <uuid> |
| title required | string [ 1 .. 255 ] characters |
| start_time required | string <date-time> |
| end_time required | string <date-time> |
| kind | string (Kind20fEnum) Enum: "break" "networking" "booth" "room" "booth2"
|
| is_live | boolean |
| description | string or null |
| track | Array of strings <uuid> [ items <uuid > ] |
| live_start_time | string or null <date-time> |
| live_end_time | string or null <date-time> |
{- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "title": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "kind": "break",
- "is_live": true,
- "description": "string",
- "track": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z"
}{- "id": 0,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "title": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "kind": "break",
- "is_live": true,
- "description": "string",
- "expected_end_time": "2019-08-24T14:15:22Z",
- "allowed_end_time": "2019-08-24T14:15:22Z",
- "allowed_start_time": "2019-08-24T14:15:22Z",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z"
}| id required | integer A unique integer value identifying this agenda item. |
| event | string <uuid> |
| title | string [ 1 .. 255 ] characters |
| start_time | string <date-time> |
| end_time | string <date-time> |
| kind | string (Kind20fEnum) Enum: "break" "networking" "booth" "room" "booth2"
|
| is_live | boolean |
| description | string or null |
| track | Array of strings <uuid> [ items <uuid > ] |
| live_start_time | string or null <date-time> |
| live_end_time | string or null <date-time> |
{- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "title": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "kind": "break",
- "is_live": true,
- "description": "string",
- "track": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z"
}{- "id": 0,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "title": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "kind": "break",
- "is_live": true,
- "description": "string",
- "expected_end_time": "2019-08-24T14:15:22Z",
- "allowed_end_time": "2019-08-24T14:15:22Z",
- "allowed_start_time": "2019-08-24T14:15:22Z",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z"
}| booth_type | string Enum: "Primary" "Secondary"
|
| event | string <uuid> |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| ordering | string Which field to use when ordering the results. |
| recommended | Array of strings Multiple values may be separated by commas. |
| search | string A search term. |
| tags | string |
{- "count": 123,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
}
]
}Array of objects (ResourceRequest) | |
| rank | integer [ -2147483648 .. 2147483647 ] |
| name required | string [ 1 .. 127 ] characters |
| description | string or null |
| booth_type | string (BoothTypeEnum) Enum: "Primary" "Secondary"
|
| logo | string or null <= 1024 characters |
| sponsor_link | string or null <uri> <= 1024 characters |
| poster | string or null <= 1024 characters |
| tags | Array of strings or null[ items [ 1 .. 31 ] characters ] |
| hero_asset | string or null <= 500 characters |
(HeroAssetTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| cta | string or null <= 500 characters |
| mmid | string [ 1 .. 26 ] characters |
| demo_request_title | string or null <= 500 characters |
| demo_request_message | string or null |
| demo_request_enabled | boolean |
| demo_request_button_text | string or null <= 500 characters |
| vcapture_url | string or null <uri> <= 1024 characters Validar's vCapture url to award points to attendees |
| tier | string Enum: "TIER1" "TIER2" "TIER3" Decides how booth will be displayed on frontend with Tier1 being the biggest display banner
|
| event required | string <uuid> |
| moderator | Array of strings <uuid> [ items <uuid > ] |
| discussion_group | Array of strings <uuid> [ items <uuid > ] |
{- "resources": [
- {
- "content_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
], - "rank": -2147483648,
- "name": "string",
- "description": "string",
- "booth_type": "Primary",
- "logo": "string",
- "poster": "string",
- "tags": [
- "string"
], - "hero_asset": "string",
- "hero_asset_type": "hero_asset_video",
- "cta": "string",
- "mmid": "string",
- "demo_request_title": "string",
- "demo_request_message": "string",
- "demo_request_enabled": true,
- "demo_request_button_text": "string",
- "tier": "TIER1",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "discussion_group": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
}| id required | string <uuid> A UUID string identifying this booth. |
Array of objects (ResourceRequest) | |
| rank | integer [ -2147483648 .. 2147483647 ] |
| name required | string [ 1 .. 127 ] characters |
| description | string or null |
| booth_type | string (BoothTypeEnum) Enum: "Primary" "Secondary"
|
| logo | string or null <= 1024 characters |
| sponsor_link | string or null <uri> <= 1024 characters |
| poster | string or null <= 1024 characters |
| tags | Array of strings or null[ items [ 1 .. 31 ] characters ] |
| hero_asset | string or null <= 500 characters |
(HeroAssetTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| cta | string or null <= 500 characters |
| mmid | string [ 1 .. 26 ] characters |
| demo_request_title | string or null <= 500 characters |
| demo_request_message | string or null |
| demo_request_enabled | boolean |
| demo_request_button_text | string or null <= 500 characters |
| vcapture_url | string or null <uri> <= 1024 characters Validar's vCapture url to award points to attendees |
| tier | string Enum: "TIER1" "TIER2" "TIER3" Decides how booth will be displayed on frontend with Tier1 being the biggest display banner
|
| event required | string <uuid> |
| moderator | Array of strings <uuid> [ items <uuid > ] |
| discussion_group | Array of strings <uuid> [ items <uuid > ] |
{- "resources": [
- {
- "content_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
], - "rank": -2147483648,
- "name": "string",
- "description": "string",
- "booth_type": "Primary",
- "logo": "string",
- "poster": "string",
- "tags": [
- "string"
], - "hero_asset": "string",
- "hero_asset_type": "hero_asset_video",
- "cta": "string",
- "mmid": "string",
- "demo_request_title": "string",
- "demo_request_message": "string",
- "demo_request_enabled": true,
- "demo_request_button_text": "string",
- "tier": "TIER1",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "discussion_group": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
}| id required | string <uuid> A UUID string identifying this booth. |
Array of objects (ResourceRequest) | |
| rank | integer [ -2147483648 .. 2147483647 ] |
| name | string [ 1 .. 127 ] characters |
| description | string or null |
| booth_type | string (BoothTypeEnum) Enum: "Primary" "Secondary"
|
| logo | string or null <= 1024 characters |
| sponsor_link | string or null <uri> <= 1024 characters |
| poster | string or null <= 1024 characters |
| tags | Array of strings or null[ items [ 1 .. 31 ] characters ] |
| hero_asset | string or null <= 500 characters |
(HeroAssetTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| cta | string or null <= 500 characters |
| mmid | string [ 1 .. 26 ] characters |
| demo_request_title | string or null <= 500 characters |
| demo_request_message | string or null |
| demo_request_enabled | boolean |
| demo_request_button_text | string or null <= 500 characters |
| vcapture_url | string or null <uri> <= 1024 characters Validar's vCapture url to award points to attendees |
| tier | string Enum: "TIER1" "TIER2" "TIER3" Decides how booth will be displayed on frontend with Tier1 being the biggest display banner
|
| event | string <uuid> |
| moderator | Array of strings <uuid> [ items <uuid > ] |
| discussion_group | Array of strings <uuid> [ items <uuid > ] |
{- "resources": [
- {
- "content_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
], - "rank": -2147483648,
- "name": "string",
- "description": "string",
- "booth_type": "Primary",
- "logo": "string",
- "poster": "string",
- "tags": [
- "string"
], - "hero_asset": "string",
- "hero_asset_type": "hero_asset_video",
- "cta": "string",
- "mmid": "string",
- "demo_request_title": "string",
- "demo_request_message": "string",
- "demo_request_enabled": true,
- "demo_request_button_text": "string",
- "tier": "TIER1",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "discussion_group": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
}Cvent Security Role: events:read
Cvent Auth Methods: bearer
| broadcast_type | string Enum: "HYBRID_SIMULIVE" "INHOUSE_SIMULIVE" "IN_PERSON_HYBRID" "LIVE" "LIVE_EXTERNAL" "LIVE_EXTERNAL_HYBRID" "LIVE_HYBRID" "SIMULIVE"
|
| description | string |
| end_time | string <date-time> |
| event | string <uuid> |
| event_ids | string |
| finished | boolean |
| have_polls | boolean |
| have_text_qna | boolean |
| have_video_qna | boolean |
| hide_watcher_count | boolean |
| is_live | boolean |
| limit | integer Number of results to return per page. |
| live_end_time | string <date-time> |
| live_start_time | string <date-time> |
| offset | integer The initial index from which to return the results. |
| ordering | string Which field to use when ordering the results. |
| recommended | Array of strings Multiple values may be separated by commas. |
| search | string A search term. |
| simulive_link | string |
| start_time | string <date-time> |
| tags | string |
| title | string |
{- "count": 123,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "medialive_rtmp_input_details": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "channel_states": "CREATING",
- "channel_id": "string",
- "input_url": "string",
- "failover_input_url": "string",
- "output_url": "string",
- "in_stream_key": "0a3587fe-6193-4af8-a486-20a574470895",
- "failover_in_stream_key": "85727433-a23a-414a-8d46-196b86c771ed",
- "test_run_end_time": "2019-08-24T14:15:22Z",
- "input_frame_rate_alarm_state": "string",
- "input_frame_rate_alert_sent": true,
- "network_in_alarm_state": "string",
- "network_in_alert_sent": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}, - "on_demand_asset": "string",
- "surveys": "string",
- "expected_end_time": "2019-08-24T14:15:22Z",
- "allowed_end_time": "2019-08-24T14:15:22Z",
- "allowed_start_time": "2019-08-24T14:15:22Z",
- "manual_redirection_enabled": "string",
- "custom_ondemand_video_asset": "76e991f1-1c4a-4ed7-9bc5-858ec6e5245a",
- "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "layout_settings": {
- "speaker_layout": "FILL",
- "screen_share_layout": "SHARED_FILL",
- "speaker_side": "LEFT",
- "rounded_corners": true,
- "show_borders": true,
- "highlight_active_speaker": true,
- "show_active_speaker_only": true,
- "pip_shape": "CIRCULAR",
- "pip_position": "LEFT_TOP"
}, - "webinar_config": null,
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "description": "string",
- "location": "string",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z",
- "have_video_qna": true,
- "have_text_qna": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "have_polls": true,
- "is_on_demand": true,
- "is_live": true,
- "recording": null,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "mmid": "string",
- "poll_channel_mmid": "string",
- "video_qna_channel_mmid": "string",
- "text_qna_channel_mmid": "string",
- "speaker_chat_mmid": "string",
- "live_captions_mmid": "string",
- "is_joinable": true,
- "external_stream_url": "string",
- "broadcast_type": "LIVE",
- "simulive_link": "string",
- "is_hybrid_playing_simulive": true,
- "external_rtmp_push_stream": "string",
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "isVbr": true,
- "is_hls_low": true,
- "is_hls_med": true,
- "is_hls_high": true,
- "is_recording": true,
- "latest_recording_timestamp": "string",
- "recording_task_arn": "string",
- "recording_dir_prefix": "string",
- "playback_start_time": "2019-08-24T14:15:22Z",
- "current_playing_slide_number": -2147483648,
- "current_playing_step_number": -2147483648,
- "slide_state_version": -9223372036854776000,
- "screen_share_layout": "FLOATING",
- "simulive_video_switch_source_map": null,
- "medialive_channel_data": null,
- "sort_priority": -2147483648,
- "medialive_channel_state": "CREATING",
- "wordly_session_id": "string",
- "wordly_session_key": "string",
- "stage_logo_spec": null,
- "lower_third_spec": null,
- "validar_guid": "string",
- "simulive_test_run_end_time": "2019-08-24T14:15:22Z",
- "round_videos": true,
- "show_active_speaker_only": true,
- "is_available_on_demand": true,
- "overlay_text": "string",
- "show_overlay": true,
- "ticker_text": "string",
- "show_ticker": true,
- "slido_poll_embed_url": "string",
- "slido_qa_embed_url": "string",
- "content_repurposing_enabled": true,
- "on_demand_recording_published": true,
- "ppt_task_launch_time": "2019-08-24T14:15:22Z",
- "use_medialive_channel": true,
- "slide_asset_viewer_state": "NOT_INITIATED",
- "run_of_show_config": null,
- "on_demand_run_of_show_config": null,
- "is_automated_run_of_show": true,
- "recording_studio_state": "NOT_INITIALIZED",
- "session_language": "string",
- "local_recording_fps": -2147483648,
- "use_pure_cloud_recording": true,
- "enable_live_run_of_show": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "current_playing_video_asset": "4b45101d-061c-40ce-8e5b-239db1b819e1",
- "current_playing_slide_asset": "8f60b14a-43b8-4a76-a448-5777c97995c0",
- "medialive_rtmp_input": "2c54919a-4f4a-4171-aa51-9df3526b4ecb",
- "sign_language_translator_user_id": "7df3698b-558d-424f-a5ec-002e323b163e",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "speakers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "staffs": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]
}| video_assets required | Array of strings <uuid> [ items <uuid > ] |
| slide_assets required | Array of strings <uuid> [ items <uuid > ] |
| recording_video_asset | string or null <uuid> |
| custom_ondemand_video_asset | string or null <uuid> |
Array of objects (PollQuestionBroadcastRequest) | |
| tracks required | Array of strings <uuid> [ items <uuid > ] |
Array of objects (ResourceBroadcastRequestRequest) | |
object (KudoConfigRequest) | |
object or null | |
| ticker_url | string or null <uri> |
| webinar_config | any |
Array of objects (SpeakerRoleMapRequest) | |
| title required | string [ 1 .. 255 ] characters |
| description | string or null |
| location | string or null Physical Location of the Broadcast to be shown in Hybrid Events |
| live_start_time | string or null <date-time> |
| live_end_time | string or null <date-time> |
| have_video_qna | boolean |
| have_text_qna | boolean |
| hide_watcher_count | boolean Decides if watcher count would be visible for attendees |
| show_watcher_count_speakers | boolean Decides if watcher count is visible to speakers/organizers |
| is_on_demand | boolean |
| is_live | boolean |
| recording | any or null |
| start_time required | string <date-time> |
| end_time required | string <date-time> |
| tags | Array of strings or null[ items [ 1 .. 31 ] characters ] |
| mmid | string [ 1 .. 26 ] characters |
| poll_channel_mmid | string [ 1 .. 26 ] characters |
| video_qna_channel_mmid | string [ 1 .. 26 ] characters |
| text_qna_channel_mmid | string [ 1 .. 26 ] characters |
| speaker_chat_mmid | string [ 1 .. 26 ] characters |
| live_captions_mmid | string [ 1 .. 26 ] characters used for delivery of generated live captions to a broadcast |
| is_joinable | boolean |
| external_stream_url | string or null <= 1024 characters |
| broadcast_type | string (BroadcastType466Enum) Enum: "LIVE" "LIVE_EXTERNAL" "LIVE_HYBRID" "LIVE_EXTERNAL_HYBRID" "SIMULIVE" "INHOUSE_SIMULIVE" "HYBRID_SIMULIVE" "IN_PERSON_HYBRID"
|
| simulive_link | string or null <= 127 characters |
| is_hybrid_playing_simulive | boolean |
| external_rtmp_push_stream | string or null <= 255 characters |
| youtube_live_url | string or null <= 1024 characters |
| facebook_live_url | string or null <= 1024 characters |
| youtube_stream_key | string or null <= 127 characters |
| facebook_stream_key | string or null <= 127 characters |
| custom_stream_url | string or null <= 1024 characters |
| custom_stream_key | string or null <= 127 characters |
| isVbr | boolean |
| is_hls_low | boolean |
| is_hls_med | boolean |
| is_hls_high | boolean |
| is_recording | boolean |
| latest_recording_timestamp | string or null <= 127 characters |
| recording_task_arn | string or null <= 127 characters |
| recording_dir_prefix | string or null <= 256 characters Recording Directory Prefix in S3 |
| playback_start_time | string or null <date-time> stores the start datetime of the selected video to be played in the broadcast |
| current_playing_slide_number | integer or null [ -2147483648 .. 2147483647 ] |
| current_playing_step_number | integer or null [ -2147483648 .. 2147483647 ] |
| slide_state_version | integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ] |
| screen_share_layout | string (ScreenShareLayout313Enum) Enum: "FLOATING" "FLEX" "NO_SPEAKER_VIDEOS" "UNDER_SCREEN" "TOP_OF_VIDEO" "FLEX_16_9"
|
| simulive_video_switch_source_map | any or null |
| medialive_channel_data | any |
| sort_priority | integer [ -2147483648 .. 2147483647 ] |
| medialive_channel_state | string (MedialiveChannelStateEnum) Enum: "CREATING" "CREATE_FAILED" "IDLE" "STARTING" "RUNNING" "RECOVERING" "STOPPING" "STOPPED" "DELETING" "DELETED" "UPDATING" "UPDATE_FAILED" "NOT_PRESENT"
|
| wordly_session_id | string or null [ 1 .. 64 ] characters Used for storing the session ID for wordly translation session. |
| wordly_session_key | string or null [ 1 .. 64 ] characters Used to store the private key for the wordly session if the session is a private one. |
| stage_logo_spec | any or null Contains url and position of logo on stage |
| lower_third_spec | any or null Contains post or text information for lower thirds |
| validar_vcapture_url | string or null <uri> [ 1 .. 1024 ] characters Points to a validar vcapture url for a broadcast |
| validar_guid | string or null [ 1 .. 255 ] characters A field that maps goldcast's broadcast with validar's session (sessionGuid) |
| simulive_test_run_end_time | string or null <date-time> Stores the expected end time of simulive test run |
| round_videos | boolean Show circular frame around video |
| show_active_speaker_only | boolean Show active speaker only |
| is_available_on_demand | boolean Allows organizers to disable on-demand recording of this session. Default is True, so that by default all broadcasts are published when event's is_available_on_demand flag is set to True. |
| overlay_text | string or null Overlay text |
| show_overlay | boolean Is overlay published on stage? |
| ticker_text | string or null Ticket text |
| show_ticker | boolean Is ticket published on stage? |
| slido_poll_embed_url | string or null <= 1024 characters Stores the url for slido integration which will replace Goldcast poll UI with an iframe. |
| slido_qa_embed_url | string or null <= 1024 characters Stores the url for slido integration which will replace Goldcast q&a UI with an iframe. |
| content_repurposing_enabled | boolean A flag to enable content-lab for a session once all the required files (like speaker transcripts) are generated for this sessions by the batch-transcripter service |
| on_demand_transcript_url | string or null <uri> <= 1024 characters URL for the transcript file for the session |
| on_demand_recording_published | boolean Flag to indicate if the recording of the session is published on demand |
| ppt_task_launch_time | string or null <date-time> time when the ppt task was launched |
| use_medialive_channel | boolean Flag to indicate if the broadcast can use medialive channel |
| slide_asset_viewer_state | string (SlideAssetViewerStateEnum) Enum: "NOT_INITIATED" "INITIATED" "COMPLETED" "RUNNING" "CLOSED" "FAILED"
|
| run_of_show_config | any or null Contains automated run of show config |
| on_demand_run_of_show_config | any or null Contains automated run of show config for on-demand playback |
| is_automated_run_of_show | boolean Is broadcast running with automated run of show |
| recording_studio_state | string (RecordingStudioStateEnum) Enum: "NOT_INITIALIZED" "RECORDING" "STOPPED" "PAUSED" "STARTING"
|
| session_language | string [ 1 .. 6 ] characters field to select the language for a session this will be used to power the language of captions and subtitles as of now, in future we will use this to power the language of the session |
| local_recording_fps | integer [ -2147483648 .. 2147483647 ] FPS for local recording |
| use_pure_cloud_recording | boolean Flag to indicate if video editor should use pure cloud recording |
| enable_live_run_of_show | boolean Indicates whether live run of show is enabled for the broadcast |
| event required | string <uuid> |
| current_playing_video_asset | string or null <uuid> |
| current_playing_slide_asset | string or null <uuid> |
| medialive_rtmp_input | string or null <uuid> |
| sign_language_translator_user_id | string or null <uuid> |
| moderator | Array of strings <uuid> [ items <uuid > ] |
| speakers | Array of strings <uuid> [ items <uuid > ] |
| staffs | Array of strings <uuid> [ items <uuid > ] |
{- "video_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "slide_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "recording_video_asset": "54693be3-d852-4817-9c74-f14d44fe06f5",
- "custom_ondemand_video_asset": "76e991f1-1c4a-4ed7-9bc5-858ec6e5245a",
- "polls": [
- {
- "text": "string",
- "type": "SINGLE",
- "answers": [
- {
- "text": "string",
- "id": "string"
}
], - "id": "string"
}
], - "tracks": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "layout_settings": {
- "speaker_layout": "FILL",
- "screen_share_layout": "SHARED_FILL",
- "speaker_side": "LEFT",
- "rounded_corners": true,
- "show_borders": true,
- "highlight_active_speaker": true,
- "show_active_speaker_only": true,
- "pip_shape": "CIRCULAR",
- "pip_position": "LEFT_TOP"
}, - "webinar_config": null,
- "speaker_role_list": [
- {
- "speaker": "c3231b02-0a29-4616-9ff3-110413997df8",
- "role": "string"
}
], - "title": "string",
- "description": "string",
- "location": "string",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z",
- "have_video_qna": true,
- "have_text_qna": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "is_on_demand": true,
- "is_live": true,
- "recording": null,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "mmid": "string",
- "poll_channel_mmid": "string",
- "video_qna_channel_mmid": "string",
- "text_qna_channel_mmid": "string",
- "speaker_chat_mmid": "string",
- "live_captions_mmid": "string",
- "is_joinable": true,
- "external_stream_url": "string",
- "broadcast_type": "LIVE",
- "simulive_link": "string",
- "is_hybrid_playing_simulive": true,
- "external_rtmp_push_stream": "string",
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "isVbr": true,
- "is_hls_low": true,
- "is_hls_med": true,
- "is_hls_high": true,
- "is_recording": true,
- "latest_recording_timestamp": "string",
- "recording_task_arn": "string",
- "recording_dir_prefix": "string",
- "playback_start_time": "2019-08-24T14:15:22Z",
- "current_playing_slide_number": -2147483648,
- "current_playing_step_number": -2147483648,
- "slide_state_version": -9223372036854776000,
- "screen_share_layout": "FLOATING",
- "simulive_video_switch_source_map": null,
- "medialive_channel_data": null,
- "sort_priority": -2147483648,
- "medialive_channel_state": "CREATING",
- "wordly_session_id": "string",
- "wordly_session_key": "string",
- "stage_logo_spec": null,
- "lower_third_spec": null,
- "validar_guid": "string",
- "simulive_test_run_end_time": "2019-08-24T14:15:22Z",
- "round_videos": true,
- "show_active_speaker_only": true,
- "is_available_on_demand": true,
- "overlay_text": "string",
- "show_overlay": true,
- "ticker_text": "string",
- "show_ticker": true,
- "slido_poll_embed_url": "string",
- "slido_qa_embed_url": "string",
- "content_repurposing_enabled": true,
- "on_demand_recording_published": true,
- "ppt_task_launch_time": "2019-08-24T14:15:22Z",
- "use_medialive_channel": true,
- "slide_asset_viewer_state": "NOT_INITIATED",
- "run_of_show_config": null,
- "on_demand_run_of_show_config": null,
- "is_automated_run_of_show": true,
- "recording_studio_state": "NOT_INITIALIZED",
- "session_language": "string",
- "local_recording_fps": -2147483648,
- "use_pure_cloud_recording": true,
- "enable_live_run_of_show": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "current_playing_video_asset": "4b45101d-061c-40ce-8e5b-239db1b819e1",
- "current_playing_slide_asset": "8f60b14a-43b8-4a76-a448-5777c97995c0",
- "medialive_rtmp_input": "2c54919a-4f4a-4171-aa51-9df3526b4ecb",
- "sign_language_translator_user_id": "7df3698b-558d-424f-a5ec-002e323b163e",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "speakers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "staffs": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "medialive_rtmp_input_details": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "channel_states": "CREATING",
- "channel_id": "string",
- "input_url": "string",
- "failover_input_url": "string",
- "output_url": "string",
- "in_stream_key": "0a3587fe-6193-4af8-a486-20a574470895",
- "failover_in_stream_key": "85727433-a23a-414a-8d46-196b86c771ed",
- "test_run_end_time": "2019-08-24T14:15:22Z",
- "input_frame_rate_alarm_state": "string",
- "input_frame_rate_alert_sent": true,
- "network_in_alarm_state": "string",
- "network_in_alert_sent": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}, - "on_demand_asset": "string",
- "surveys": "string",
- "expected_end_time": "2019-08-24T14:15:22Z",
- "allowed_end_time": "2019-08-24T14:15:22Z",
- "allowed_start_time": "2019-08-24T14:15:22Z",
- "manual_redirection_enabled": "string",
- "custom_ondemand_video_asset": "76e991f1-1c4a-4ed7-9bc5-858ec6e5245a",
- "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "layout_settings": {
- "speaker_layout": "FILL",
- "screen_share_layout": "SHARED_FILL",
- "speaker_side": "LEFT",
- "rounded_corners": true,
- "show_borders": true,
- "highlight_active_speaker": true,
- "show_active_speaker_only": true,
- "pip_shape": "CIRCULAR",
- "pip_position": "LEFT_TOP"
}, - "webinar_config": null,
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "description": "string",
- "location": "string",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z",
- "have_video_qna": true,
- "have_text_qna": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "have_polls": true,
- "is_on_demand": true,
- "is_live": true,
- "recording": null,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "mmid": "string",
- "poll_channel_mmid": "string",
- "video_qna_channel_mmid": "string",
- "text_qna_channel_mmid": "string",
- "speaker_chat_mmid": "string",
- "live_captions_mmid": "string",
- "is_joinable": true,
- "external_stream_url": "string",
- "broadcast_type": "LIVE",
- "simulive_link": "string",
- "is_hybrid_playing_simulive": true,
- "external_rtmp_push_stream": "string",
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "isVbr": true,
- "is_hls_low": true,
- "is_hls_med": true,
- "is_hls_high": true,
- "is_recording": true,
- "latest_recording_timestamp": "string",
- "recording_task_arn": "string",
- "recording_dir_prefix": "string",
- "playback_start_time": "2019-08-24T14:15:22Z",
- "current_playing_slide_number": -2147483648,
- "current_playing_step_number": -2147483648,
- "slide_state_version": -9223372036854776000,
- "screen_share_layout": "FLOATING",
- "simulive_video_switch_source_map": null,
- "medialive_channel_data": null,
- "sort_priority": -2147483648,
- "medialive_channel_state": "CREATING",
- "wordly_session_id": "string",
- "wordly_session_key": "string",
- "stage_logo_spec": null,
- "lower_third_spec": null,
- "validar_guid": "string",
- "simulive_test_run_end_time": "2019-08-24T14:15:22Z",
- "round_videos": true,
- "show_active_speaker_only": true,
- "is_available_on_demand": true,
- "overlay_text": "string",
- "show_overlay": true,
- "ticker_text": "string",
- "show_ticker": true,
- "slido_poll_embed_url": "string",
- "slido_qa_embed_url": "string",
- "content_repurposing_enabled": true,
- "on_demand_recording_published": true,
- "ppt_task_launch_time": "2019-08-24T14:15:22Z",
- "use_medialive_channel": true,
- "slide_asset_viewer_state": "NOT_INITIATED",
- "run_of_show_config": null,
- "on_demand_run_of_show_config": null,
- "is_automated_run_of_show": true,
- "recording_studio_state": "NOT_INITIALIZED",
- "session_language": "string",
- "local_recording_fps": -2147483648,
- "use_pure_cloud_recording": true,
- "enable_live_run_of_show": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "current_playing_video_asset": "4b45101d-061c-40ce-8e5b-239db1b819e1",
- "current_playing_slide_asset": "8f60b14a-43b8-4a76-a448-5777c97995c0",
- "medialive_rtmp_input": "2c54919a-4f4a-4171-aa51-9df3526b4ecb",
- "sign_language_translator_user_id": "7df3698b-558d-424f-a5ec-002e323b163e",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "speakers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "staffs": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}| id required | string <uuid> A UUID string identifying this broadcast. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "medialive_rtmp_input_details": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "channel_states": "CREATING",
- "channel_id": "string",
- "input_url": "string",
- "failover_input_url": "string",
- "output_url": "string",
- "in_stream_key": "0a3587fe-6193-4af8-a486-20a574470895",
- "failover_in_stream_key": "85727433-a23a-414a-8d46-196b86c771ed",
- "test_run_end_time": "2019-08-24T14:15:22Z",
- "input_frame_rate_alarm_state": "string",
- "input_frame_rate_alert_sent": true,
- "network_in_alarm_state": "string",
- "network_in_alert_sent": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}, - "on_demand_asset": "string",
- "surveys": "string",
- "expected_end_time": "2019-08-24T14:15:22Z",
- "allowed_end_time": "2019-08-24T14:15:22Z",
- "allowed_start_time": "2019-08-24T14:15:22Z",
- "manual_redirection_enabled": "string",
- "custom_ondemand_video_asset": "76e991f1-1c4a-4ed7-9bc5-858ec6e5245a",
- "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "layout_settings": {
- "speaker_layout": "FILL",
- "screen_share_layout": "SHARED_FILL",
- "speaker_side": "LEFT",
- "rounded_corners": true,
- "show_borders": true,
- "highlight_active_speaker": true,
- "show_active_speaker_only": true,
- "pip_shape": "CIRCULAR",
- "pip_position": "LEFT_TOP"
}, - "webinar_config": null,
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "description": "string",
- "location": "string",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z",
- "have_video_qna": true,
- "have_text_qna": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "have_polls": true,
- "is_on_demand": true,
- "is_live": true,
- "recording": null,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "mmid": "string",
- "poll_channel_mmid": "string",
- "video_qna_channel_mmid": "string",
- "text_qna_channel_mmid": "string",
- "speaker_chat_mmid": "string",
- "live_captions_mmid": "string",
- "is_joinable": true,
- "external_stream_url": "string",
- "broadcast_type": "LIVE",
- "simulive_link": "string",
- "is_hybrid_playing_simulive": true,
- "external_rtmp_push_stream": "string",
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "isVbr": true,
- "is_hls_low": true,
- "is_hls_med": true,
- "is_hls_high": true,
- "is_recording": true,
- "latest_recording_timestamp": "string",
- "recording_task_arn": "string",
- "recording_dir_prefix": "string",
- "playback_start_time": "2019-08-24T14:15:22Z",
- "current_playing_slide_number": -2147483648,
- "current_playing_step_number": -2147483648,
- "slide_state_version": -9223372036854776000,
- "screen_share_layout": "FLOATING",
- "simulive_video_switch_source_map": null,
- "medialive_channel_data": null,
- "sort_priority": -2147483648,
- "medialive_channel_state": "CREATING",
- "wordly_session_id": "string",
- "wordly_session_key": "string",
- "stage_logo_spec": null,
- "lower_third_spec": null,
- "validar_guid": "string",
- "simulive_test_run_end_time": "2019-08-24T14:15:22Z",
- "round_videos": true,
- "show_active_speaker_only": true,
- "is_available_on_demand": true,
- "overlay_text": "string",
- "show_overlay": true,
- "ticker_text": "string",
- "show_ticker": true,
- "slido_poll_embed_url": "string",
- "slido_qa_embed_url": "string",
- "content_repurposing_enabled": true,
- "on_demand_recording_published": true,
- "ppt_task_launch_time": "2019-08-24T14:15:22Z",
- "use_medialive_channel": true,
- "slide_asset_viewer_state": "NOT_INITIATED",
- "run_of_show_config": null,
- "on_demand_run_of_show_config": null,
- "is_automated_run_of_show": true,
- "recording_studio_state": "NOT_INITIALIZED",
- "session_language": "string",
- "local_recording_fps": -2147483648,
- "use_pure_cloud_recording": true,
- "enable_live_run_of_show": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "current_playing_video_asset": "4b45101d-061c-40ce-8e5b-239db1b819e1",
- "current_playing_slide_asset": "8f60b14a-43b8-4a76-a448-5777c97995c0",
- "medialive_rtmp_input": "2c54919a-4f4a-4171-aa51-9df3526b4ecb",
- "sign_language_translator_user_id": "7df3698b-558d-424f-a5ec-002e323b163e",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "speakers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "staffs": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}| id required | string <uuid> A UUID string identifying this broadcast. |
| video_assets required | Array of strings <uuid> [ items <uuid > ] |
| slide_assets required | Array of strings <uuid> [ items <uuid > ] |
| recording_video_asset | string or null <uuid> |
| custom_ondemand_video_asset | string or null <uuid> |
Array of objects (PollQuestionBroadcastRequest) | |
| tracks required | Array of strings <uuid> [ items <uuid > ] |
Array of objects (ResourceBroadcastRequestRequest) | |
object (KudoConfigRequest) | |
object or null | |
| ticker_url | string or null <uri> |
| webinar_config | any |
Array of objects (SpeakerRoleMapRequest) | |
| title required | string [ 1 .. 255 ] characters |
| description | string or null |
| location | string or null Physical Location of the Broadcast to be shown in Hybrid Events |
| live_start_time | string or null <date-time> |
| live_end_time | string or null <date-time> |
| have_video_qna | boolean |
| have_text_qna | boolean |
| hide_watcher_count | boolean Decides if watcher count would be visible for attendees |
| show_watcher_count_speakers | boolean Decides if watcher count is visible to speakers/organizers |
| is_on_demand | boolean |
| is_live | boolean |
| recording | any or null |
| start_time required | string <date-time> |
| end_time required | string <date-time> |
| tags | Array of strings or null[ items [ 1 .. 31 ] characters ] |
| mmid | string [ 1 .. 26 ] characters |
| poll_channel_mmid | string [ 1 .. 26 ] characters |
| video_qna_channel_mmid | string [ 1 .. 26 ] characters |
| text_qna_channel_mmid | string [ 1 .. 26 ] characters |
| speaker_chat_mmid | string [ 1 .. 26 ] characters |
| live_captions_mmid | string [ 1 .. 26 ] characters used for delivery of generated live captions to a broadcast |
| is_joinable | boolean |
| external_stream_url | string or null <= 1024 characters |
| broadcast_type | string (BroadcastType466Enum) Enum: "LIVE" "LIVE_EXTERNAL" "LIVE_HYBRID" "LIVE_EXTERNAL_HYBRID" "SIMULIVE" "INHOUSE_SIMULIVE" "HYBRID_SIMULIVE" "IN_PERSON_HYBRID"
|
| simulive_link | string or null <= 127 characters |
| is_hybrid_playing_simulive | boolean |
| external_rtmp_push_stream | string or null <= 255 characters |
| youtube_live_url | string or null <= 1024 characters |
| facebook_live_url | string or null <= 1024 characters |
| youtube_stream_key | string or null <= 127 characters |
| facebook_stream_key | string or null <= 127 characters |
| custom_stream_url | string or null <= 1024 characters |
| custom_stream_key | string or null <= 127 characters |
| isVbr | boolean |
| is_hls_low | boolean |
| is_hls_med | boolean |
| is_hls_high | boolean |
| is_recording | boolean |
| latest_recording_timestamp | string or null <= 127 characters |
| recording_task_arn | string or null <= 127 characters |
| recording_dir_prefix | string or null <= 256 characters Recording Directory Prefix in S3 |
| playback_start_time | string or null <date-time> stores the start datetime of the selected video to be played in the broadcast |
| current_playing_slide_number | integer or null [ -2147483648 .. 2147483647 ] |
| current_playing_step_number | integer or null [ -2147483648 .. 2147483647 ] |
| slide_state_version | integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ] |
| screen_share_layout | string (ScreenShareLayout313Enum) Enum: "FLOATING" "FLEX" "NO_SPEAKER_VIDEOS" "UNDER_SCREEN" "TOP_OF_VIDEO" "FLEX_16_9"
|
| simulive_video_switch_source_map | any or null |
| medialive_channel_data | any |
| sort_priority | integer [ -2147483648 .. 2147483647 ] |
| medialive_channel_state | string (MedialiveChannelStateEnum) Enum: "CREATING" "CREATE_FAILED" "IDLE" "STARTING" "RUNNING" "RECOVERING" "STOPPING" "STOPPED" "DELETING" "DELETED" "UPDATING" "UPDATE_FAILED" "NOT_PRESENT"
|
| wordly_session_id | string or null [ 1 .. 64 ] characters Used for storing the session ID for wordly translation session. |
| wordly_session_key | string or null [ 1 .. 64 ] characters Used to store the private key for the wordly session if the session is a private one. |
| stage_logo_spec | any or null Contains url and position of logo on stage |
| lower_third_spec | any or null Contains post or text information for lower thirds |
| validar_vcapture_url | string or null <uri> [ 1 .. 1024 ] characters Points to a validar vcapture url for a broadcast |
| validar_guid | string or null [ 1 .. 255 ] characters A field that maps goldcast's broadcast with validar's session (sessionGuid) |
| simulive_test_run_end_time | string or null <date-time> Stores the expected end time of simulive test run |
| round_videos | boolean Show circular frame around video |
| show_active_speaker_only | boolean Show active speaker only |
| is_available_on_demand | boolean Allows organizers to disable on-demand recording of this session. Default is True, so that by default all broadcasts are published when event's is_available_on_demand flag is set to True. |
| overlay_text | string or null Overlay text |
| show_overlay | boolean Is overlay published on stage? |
| ticker_text | string or null Ticket text |
| show_ticker | boolean Is ticket published on stage? |
| slido_poll_embed_url | string or null <= 1024 characters Stores the url for slido integration which will replace Goldcast poll UI with an iframe. |
| slido_qa_embed_url | string or null <= 1024 characters Stores the url for slido integration which will replace Goldcast q&a UI with an iframe. |
| content_repurposing_enabled | boolean A flag to enable content-lab for a session once all the required files (like speaker transcripts) are generated for this sessions by the batch-transcripter service |
| on_demand_transcript_url | string or null <uri> <= 1024 characters URL for the transcript file for the session |
| on_demand_recording_published | boolean Flag to indicate if the recording of the session is published on demand |
| ppt_task_launch_time | string or null <date-time> time when the ppt task was launched |
| use_medialive_channel | boolean Flag to indicate if the broadcast can use medialive channel |
| slide_asset_viewer_state | string (SlideAssetViewerStateEnum) Enum: "NOT_INITIATED" "INITIATED" "COMPLETED" "RUNNING" "CLOSED" "FAILED"
|
| run_of_show_config | any or null Contains automated run of show config |
| on_demand_run_of_show_config | any or null Contains automated run of show config for on-demand playback |
| is_automated_run_of_show | boolean Is broadcast running with automated run of show |
| recording_studio_state | string (RecordingStudioStateEnum) Enum: "NOT_INITIALIZED" "RECORDING" "STOPPED" "PAUSED" "STARTING"
|
| session_language | string [ 1 .. 6 ] characters field to select the language for a session this will be used to power the language of captions and subtitles as of now, in future we will use this to power the language of the session |
| local_recording_fps | integer [ -2147483648 .. 2147483647 ] FPS for local recording |
| use_pure_cloud_recording | boolean Flag to indicate if video editor should use pure cloud recording |
| enable_live_run_of_show | boolean Indicates whether live run of show is enabled for the broadcast |
| event required | string <uuid> |
| current_playing_video_asset | string or null <uuid> |
| current_playing_slide_asset | string or null <uuid> |
| medialive_rtmp_input | string or null <uuid> |
| sign_language_translator_user_id | string or null <uuid> |
| moderator | Array of strings <uuid> [ items <uuid > ] |
| speakers | Array of strings <uuid> [ items <uuid > ] |
| staffs | Array of strings <uuid> [ items <uuid > ] |
{- "video_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "slide_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "recording_video_asset": "54693be3-d852-4817-9c74-f14d44fe06f5",
- "custom_ondemand_video_asset": "76e991f1-1c4a-4ed7-9bc5-858ec6e5245a",
- "polls": [
- {
- "text": "string",
- "type": "SINGLE",
- "answers": [
- {
- "text": "string",
- "id": "string"
}
], - "id": "string"
}
], - "tracks": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "layout_settings": {
- "speaker_layout": "FILL",
- "screen_share_layout": "SHARED_FILL",
- "speaker_side": "LEFT",
- "rounded_corners": true,
- "show_borders": true,
- "highlight_active_speaker": true,
- "show_active_speaker_only": true,
- "pip_shape": "CIRCULAR",
- "pip_position": "LEFT_TOP"
}, - "webinar_config": null,
- "speaker_role_list": [
- {
- "speaker": "c3231b02-0a29-4616-9ff3-110413997df8",
- "role": "string"
}
], - "title": "string",
- "description": "string",
- "location": "string",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z",
- "have_video_qna": true,
- "have_text_qna": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "is_on_demand": true,
- "is_live": true,
- "recording": null,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "mmid": "string",
- "poll_channel_mmid": "string",
- "video_qna_channel_mmid": "string",
- "text_qna_channel_mmid": "string",
- "speaker_chat_mmid": "string",
- "live_captions_mmid": "string",
- "is_joinable": true,
- "external_stream_url": "string",
- "broadcast_type": "LIVE",
- "simulive_link": "string",
- "is_hybrid_playing_simulive": true,
- "external_rtmp_push_stream": "string",
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "isVbr": true,
- "is_hls_low": true,
- "is_hls_med": true,
- "is_hls_high": true,
- "is_recording": true,
- "latest_recording_timestamp": "string",
- "recording_task_arn": "string",
- "recording_dir_prefix": "string",
- "playback_start_time": "2019-08-24T14:15:22Z",
- "current_playing_slide_number": -2147483648,
- "current_playing_step_number": -2147483648,
- "slide_state_version": -9223372036854776000,
- "screen_share_layout": "FLOATING",
- "simulive_video_switch_source_map": null,
- "medialive_channel_data": null,
- "sort_priority": -2147483648,
- "medialive_channel_state": "CREATING",
- "wordly_session_id": "string",
- "wordly_session_key": "string",
- "stage_logo_spec": null,
- "lower_third_spec": null,
- "validar_guid": "string",
- "simulive_test_run_end_time": "2019-08-24T14:15:22Z",
- "round_videos": true,
- "show_active_speaker_only": true,
- "is_available_on_demand": true,
- "overlay_text": "string",
- "show_overlay": true,
- "ticker_text": "string",
- "show_ticker": true,
- "slido_poll_embed_url": "string",
- "slido_qa_embed_url": "string",
- "content_repurposing_enabled": true,
- "on_demand_recording_published": true,
- "ppt_task_launch_time": "2019-08-24T14:15:22Z",
- "use_medialive_channel": true,
- "slide_asset_viewer_state": "NOT_INITIATED",
- "run_of_show_config": null,
- "on_demand_run_of_show_config": null,
- "is_automated_run_of_show": true,
- "recording_studio_state": "NOT_INITIALIZED",
- "session_language": "string",
- "local_recording_fps": -2147483648,
- "use_pure_cloud_recording": true,
- "enable_live_run_of_show": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "current_playing_video_asset": "4b45101d-061c-40ce-8e5b-239db1b819e1",
- "current_playing_slide_asset": "8f60b14a-43b8-4a76-a448-5777c97995c0",
- "medialive_rtmp_input": "2c54919a-4f4a-4171-aa51-9df3526b4ecb",
- "sign_language_translator_user_id": "7df3698b-558d-424f-a5ec-002e323b163e",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "speakers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "staffs": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "medialive_rtmp_input_details": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "channel_states": "CREATING",
- "channel_id": "string",
- "input_url": "string",
- "failover_input_url": "string",
- "output_url": "string",
- "in_stream_key": "0a3587fe-6193-4af8-a486-20a574470895",
- "failover_in_stream_key": "85727433-a23a-414a-8d46-196b86c771ed",
- "test_run_end_time": "2019-08-24T14:15:22Z",
- "input_frame_rate_alarm_state": "string",
- "input_frame_rate_alert_sent": true,
- "network_in_alarm_state": "string",
- "network_in_alert_sent": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}, - "on_demand_asset": "string",
- "surveys": "string",
- "expected_end_time": "2019-08-24T14:15:22Z",
- "allowed_end_time": "2019-08-24T14:15:22Z",
- "allowed_start_time": "2019-08-24T14:15:22Z",
- "manual_redirection_enabled": "string",
- "custom_ondemand_video_asset": "76e991f1-1c4a-4ed7-9bc5-858ec6e5245a",
- "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "layout_settings": {
- "speaker_layout": "FILL",
- "screen_share_layout": "SHARED_FILL",
- "speaker_side": "LEFT",
- "rounded_corners": true,
- "show_borders": true,
- "highlight_active_speaker": true,
- "show_active_speaker_only": true,
- "pip_shape": "CIRCULAR",
- "pip_position": "LEFT_TOP"
}, - "webinar_config": null,
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "description": "string",
- "location": "string",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z",
- "have_video_qna": true,
- "have_text_qna": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "have_polls": true,
- "is_on_demand": true,
- "is_live": true,
- "recording": null,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "mmid": "string",
- "poll_channel_mmid": "string",
- "video_qna_channel_mmid": "string",
- "text_qna_channel_mmid": "string",
- "speaker_chat_mmid": "string",
- "live_captions_mmid": "string",
- "is_joinable": true,
- "external_stream_url": "string",
- "broadcast_type": "LIVE",
- "simulive_link": "string",
- "is_hybrid_playing_simulive": true,
- "external_rtmp_push_stream": "string",
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "isVbr": true,
- "is_hls_low": true,
- "is_hls_med": true,
- "is_hls_high": true,
- "is_recording": true,
- "latest_recording_timestamp": "string",
- "recording_task_arn": "string",
- "recording_dir_prefix": "string",
- "playback_start_time": "2019-08-24T14:15:22Z",
- "current_playing_slide_number": -2147483648,
- "current_playing_step_number": -2147483648,
- "slide_state_version": -9223372036854776000,
- "screen_share_layout": "FLOATING",
- "simulive_video_switch_source_map": null,
- "medialive_channel_data": null,
- "sort_priority": -2147483648,
- "medialive_channel_state": "CREATING",
- "wordly_session_id": "string",
- "wordly_session_key": "string",
- "stage_logo_spec": null,
- "lower_third_spec": null,
- "validar_guid": "string",
- "simulive_test_run_end_time": "2019-08-24T14:15:22Z",
- "round_videos": true,
- "show_active_speaker_only": true,
- "is_available_on_demand": true,
- "overlay_text": "string",
- "show_overlay": true,
- "ticker_text": "string",
- "show_ticker": true,
- "slido_poll_embed_url": "string",
- "slido_qa_embed_url": "string",
- "content_repurposing_enabled": true,
- "on_demand_recording_published": true,
- "ppt_task_launch_time": "2019-08-24T14:15:22Z",
- "use_medialive_channel": true,
- "slide_asset_viewer_state": "NOT_INITIATED",
- "run_of_show_config": null,
- "on_demand_run_of_show_config": null,
- "is_automated_run_of_show": true,
- "recording_studio_state": "NOT_INITIALIZED",
- "session_language": "string",
- "local_recording_fps": -2147483648,
- "use_pure_cloud_recording": true,
- "enable_live_run_of_show": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "current_playing_video_asset": "4b45101d-061c-40ce-8e5b-239db1b819e1",
- "current_playing_slide_asset": "8f60b14a-43b8-4a76-a448-5777c97995c0",
- "medialive_rtmp_input": "2c54919a-4f4a-4171-aa51-9df3526b4ecb",
- "sign_language_translator_user_id": "7df3698b-558d-424f-a5ec-002e323b163e",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "speakers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "staffs": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}Cvent Security Role: events:write
Cvent Auth Methods: bearer
| id required | string <uuid> A UUID string identifying this broadcast. |
| video_assets | Array of strings <uuid> [ items <uuid > ] |
| slide_assets | Array of strings <uuid> [ items <uuid > ] |
| recording_video_asset | string or null <uuid> |
| custom_ondemand_video_asset | string or null <uuid> |
Array of objects (PollQuestionBroadcastRequest) | |
| tracks | Array of strings <uuid> [ items <uuid > ] |
Array of objects (ResourceBroadcastRequestRequest) | |
object (KudoConfigRequest) | |
object or null | |
| ticker_url | string or null <uri> |
| webinar_config | any |
Array of objects (SpeakerRoleMapRequest) | |
| title | string [ 1 .. 255 ] characters |
| description | string or null |
| location | string or null Physical Location of the Broadcast to be shown in Hybrid Events |
| live_start_time | string or null <date-time> |
| live_end_time | string or null <date-time> |
| have_video_qna | boolean |
| have_text_qna | boolean |
| hide_watcher_count | boolean Decides if watcher count would be visible for attendees |
| show_watcher_count_speakers | boolean Decides if watcher count is visible to speakers/organizers |
| is_on_demand | boolean |
| is_live | boolean |
| recording | any or null |
| start_time | string <date-time> |
| end_time | string <date-time> |
| tags | Array of strings or null[ items [ 1 .. 31 ] characters ] |
| mmid | string [ 1 .. 26 ] characters |
| poll_channel_mmid | string [ 1 .. 26 ] characters |
| video_qna_channel_mmid | string [ 1 .. 26 ] characters |
| text_qna_channel_mmid | string [ 1 .. 26 ] characters |
| speaker_chat_mmid | string [ 1 .. 26 ] characters |
| live_captions_mmid | string [ 1 .. 26 ] characters used for delivery of generated live captions to a broadcast |
| is_joinable | boolean |
| external_stream_url | string or null <= 1024 characters |
| broadcast_type | string (BroadcastType466Enum) Enum: "LIVE" "LIVE_EXTERNAL" "LIVE_HYBRID" "LIVE_EXTERNAL_HYBRID" "SIMULIVE" "INHOUSE_SIMULIVE" "HYBRID_SIMULIVE" "IN_PERSON_HYBRID"
|
| simulive_link | string or null <= 127 characters |
| is_hybrid_playing_simulive | boolean |
| external_rtmp_push_stream | string or null <= 255 characters |
| youtube_live_url | string or null <= 1024 characters |
| facebook_live_url | string or null <= 1024 characters |
| youtube_stream_key | string or null <= 127 characters |
| facebook_stream_key | string or null <= 127 characters |
| custom_stream_url | string or null <= 1024 characters |
| custom_stream_key | string or null <= 127 characters |
| isVbr | boolean |
| is_hls_low | boolean |
| is_hls_med | boolean |
| is_hls_high | boolean |
| is_recording | boolean |
| latest_recording_timestamp | string or null <= 127 characters |
| recording_task_arn | string or null <= 127 characters |
| recording_dir_prefix | string or null <= 256 characters Recording Directory Prefix in S3 |
| playback_start_time | string or null <date-time> stores the start datetime of the selected video to be played in the broadcast |
| current_playing_slide_number | integer or null [ -2147483648 .. 2147483647 ] |
| current_playing_step_number | integer or null [ -2147483648 .. 2147483647 ] |
| slide_state_version | integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ] |
| screen_share_layout | string (ScreenShareLayout313Enum) Enum: "FLOATING" "FLEX" "NO_SPEAKER_VIDEOS" "UNDER_SCREEN" "TOP_OF_VIDEO" "FLEX_16_9"
|
| simulive_video_switch_source_map | any or null |
| medialive_channel_data | any |
| sort_priority | integer [ -2147483648 .. 2147483647 ] |
| medialive_channel_state | string (MedialiveChannelStateEnum) Enum: "CREATING" "CREATE_FAILED" "IDLE" "STARTING" "RUNNING" "RECOVERING" "STOPPING" "STOPPED" "DELETING" "DELETED" "UPDATING" "UPDATE_FAILED" "NOT_PRESENT"
|
| wordly_session_id | string or null [ 1 .. 64 ] characters Used for storing the session ID for wordly translation session. |
| wordly_session_key | string or null [ 1 .. 64 ] characters Used to store the private key for the wordly session if the session is a private one. |
| stage_logo_spec | any or null Contains url and position of logo on stage |
| lower_third_spec | any or null Contains post or text information for lower thirds |
| validar_vcapture_url | string or null <uri> [ 1 .. 1024 ] characters Points to a validar vcapture url for a broadcast |
| validar_guid | string or null [ 1 .. 255 ] characters A field that maps goldcast's broadcast with validar's session (sessionGuid) |
| simulive_test_run_end_time | string or null <date-time> Stores the expected end time of simulive test run |
| round_videos | boolean Show circular frame around video |
| show_active_speaker_only | boolean Show active speaker only |
| is_available_on_demand | boolean Allows organizers to disable on-demand recording of this session. Default is True, so that by default all broadcasts are published when event's is_available_on_demand flag is set to True. |
| overlay_text | string or null Overlay text |
| show_overlay | boolean Is overlay published on stage? |
| ticker_text | string or null Ticket text |
| show_ticker | boolean Is ticket published on stage? |
| slido_poll_embed_url | string or null <= 1024 characters Stores the url for slido integration which will replace Goldcast poll UI with an iframe. |
| slido_qa_embed_url | string or null <= 1024 characters Stores the url for slido integration which will replace Goldcast q&a UI with an iframe. |
| content_repurposing_enabled | boolean A flag to enable content-lab for a session once all the required files (like speaker transcripts) are generated for this sessions by the batch-transcripter service |
| on_demand_transcript_url | string or null <uri> <= 1024 characters URL for the transcript file for the session |
| on_demand_recording_published | boolean Flag to indicate if the recording of the session is published on demand |
| ppt_task_launch_time | string or null <date-time> time when the ppt task was launched |
| use_medialive_channel | boolean Flag to indicate if the broadcast can use medialive channel |
| slide_asset_viewer_state | string (SlideAssetViewerStateEnum) Enum: "NOT_INITIATED" "INITIATED" "COMPLETED" "RUNNING" "CLOSED" "FAILED"
|
| run_of_show_config | any or null Contains automated run of show config |
| on_demand_run_of_show_config | any or null Contains automated run of show config for on-demand playback |
| is_automated_run_of_show | boolean Is broadcast running with automated run of show |
| recording_studio_state | string (RecordingStudioStateEnum) Enum: "NOT_INITIALIZED" "RECORDING" "STOPPED" "PAUSED" "STARTING"
|
| session_language | string [ 1 .. 6 ] characters field to select the language for a session this will be used to power the language of captions and subtitles as of now, in future we will use this to power the language of the session |
| local_recording_fps | integer [ -2147483648 .. 2147483647 ] FPS for local recording |
| use_pure_cloud_recording | boolean Flag to indicate if video editor should use pure cloud recording |
| enable_live_run_of_show | boolean Indicates whether live run of show is enabled for the broadcast |
| current_playing_video_asset | string or null <uuid> |
| current_playing_slide_asset | string or null <uuid> |
| medialive_rtmp_input | string or null <uuid> |
| sign_language_translator_user_id | string or null <uuid> |
| moderator | Array of strings <uuid> [ items <uuid > ] |
| speakers | Array of strings <uuid> [ items <uuid > ] |
| staffs | Array of strings <uuid> [ items <uuid > ] |
{- "video_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "slide_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "recording_video_asset": "54693be3-d852-4817-9c74-f14d44fe06f5",
- "custom_ondemand_video_asset": "76e991f1-1c4a-4ed7-9bc5-858ec6e5245a",
- "polls": [
- {
- "text": "string",
- "type": "SINGLE",
- "answers": [
- {
- "text": "string",
- "id": "string"
}
], - "id": "string"
}
], - "tracks": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "layout_settings": {
- "speaker_layout": "FILL",
- "screen_share_layout": "SHARED_FILL",
- "speaker_side": "LEFT",
- "rounded_corners": true,
- "show_borders": true,
- "highlight_active_speaker": true,
- "show_active_speaker_only": true,
- "pip_shape": "CIRCULAR",
- "pip_position": "LEFT_TOP"
}, - "webinar_config": null,
- "speaker_role_list": [
- {
- "speaker": "c3231b02-0a29-4616-9ff3-110413997df8",
- "role": "string"
}
], - "title": "string",
- "description": "string",
- "location": "string",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z",
- "have_video_qna": true,
- "have_text_qna": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "is_on_demand": true,
- "is_live": true,
- "recording": null,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "mmid": "string",
- "poll_channel_mmid": "string",
- "video_qna_channel_mmid": "string",
- "text_qna_channel_mmid": "string",
- "speaker_chat_mmid": "string",
- "live_captions_mmid": "string",
- "is_joinable": true,
- "external_stream_url": "string",
- "broadcast_type": "LIVE",
- "simulive_link": "string",
- "is_hybrid_playing_simulive": true,
- "external_rtmp_push_stream": "string",
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "isVbr": true,
- "is_hls_low": true,
- "is_hls_med": true,
- "is_hls_high": true,
- "is_recording": true,
- "latest_recording_timestamp": "string",
- "recording_task_arn": "string",
- "recording_dir_prefix": "string",
- "playback_start_time": "2019-08-24T14:15:22Z",
- "current_playing_slide_number": -2147483648,
- "current_playing_step_number": -2147483648,
- "slide_state_version": -9223372036854776000,
- "screen_share_layout": "FLOATING",
- "simulive_video_switch_source_map": null,
- "medialive_channel_data": null,
- "sort_priority": -2147483648,
- "medialive_channel_state": "CREATING",
- "wordly_session_id": "string",
- "wordly_session_key": "string",
- "stage_logo_spec": null,
- "lower_third_spec": null,
- "validar_guid": "string",
- "simulive_test_run_end_time": "2019-08-24T14:15:22Z",
- "round_videos": true,
- "show_active_speaker_only": true,
- "is_available_on_demand": true,
- "overlay_text": "string",
- "show_overlay": true,
- "ticker_text": "string",
- "show_ticker": true,
- "slido_poll_embed_url": "string",
- "slido_qa_embed_url": "string",
- "content_repurposing_enabled": true,
- "on_demand_recording_published": true,
- "ppt_task_launch_time": "2019-08-24T14:15:22Z",
- "use_medialive_channel": true,
- "slide_asset_viewer_state": "NOT_INITIATED",
- "run_of_show_config": null,
- "on_demand_run_of_show_config": null,
- "is_automated_run_of_show": true,
- "recording_studio_state": "NOT_INITIALIZED",
- "session_language": "string",
- "local_recording_fps": -2147483648,
- "use_pure_cloud_recording": true,
- "enable_live_run_of_show": true,
- "current_playing_video_asset": "4b45101d-061c-40ce-8e5b-239db1b819e1",
- "current_playing_slide_asset": "8f60b14a-43b8-4a76-a448-5777c97995c0",
- "medialive_rtmp_input": "2c54919a-4f4a-4171-aa51-9df3526b4ecb",
- "sign_language_translator_user_id": "7df3698b-558d-424f-a5ec-002e323b163e",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "speakers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "staffs": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "medialive_rtmp_input_details": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "channel_states": "CREATING",
- "channel_id": "string",
- "input_url": "string",
- "failover_input_url": "string",
- "output_url": "string",
- "in_stream_key": "0a3587fe-6193-4af8-a486-20a574470895",
- "failover_in_stream_key": "85727433-a23a-414a-8d46-196b86c771ed",
- "test_run_end_time": "2019-08-24T14:15:22Z",
- "input_frame_rate_alarm_state": "string",
- "input_frame_rate_alert_sent": true,
- "network_in_alarm_state": "string",
- "network_in_alert_sent": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}, - "on_demand_asset": "string",
- "surveys": "string",
- "expected_end_time": "2019-08-24T14:15:22Z",
- "allowed_end_time": "2019-08-24T14:15:22Z",
- "allowed_start_time": "2019-08-24T14:15:22Z",
- "manual_redirection_enabled": "string",
- "custom_ondemand_video_asset": "76e991f1-1c4a-4ed7-9bc5-858ec6e5245a",
- "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "layout_settings": {
- "speaker_layout": "FILL",
- "screen_share_layout": "SHARED_FILL",
- "speaker_side": "LEFT",
- "rounded_corners": true,
- "show_borders": true,
- "highlight_active_speaker": true,
- "show_active_speaker_only": true,
- "pip_shape": "CIRCULAR",
- "pip_position": "LEFT_TOP"
}, - "webinar_config": null,
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "description": "string",
- "location": "string",
- "live_start_time": "2019-08-24T14:15:22Z",
- "live_end_time": "2019-08-24T14:15:22Z",
- "have_video_qna": true,
- "have_text_qna": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "have_polls": true,
- "is_on_demand": true,
- "is_live": true,
- "recording": null,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "mmid": "string",
- "poll_channel_mmid": "string",
- "video_qna_channel_mmid": "string",
- "text_qna_channel_mmid": "string",
- "speaker_chat_mmid": "string",
- "live_captions_mmid": "string",
- "is_joinable": true,
- "external_stream_url": "string",
- "broadcast_type": "LIVE",
- "simulive_link": "string",
- "is_hybrid_playing_simulive": true,
- "external_rtmp_push_stream": "string",
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "isVbr": true,
- "is_hls_low": true,
- "is_hls_med": true,
- "is_hls_high": true,
- "is_recording": true,
- "latest_recording_timestamp": "string",
- "recording_task_arn": "string",
- "recording_dir_prefix": "string",
- "playback_start_time": "2019-08-24T14:15:22Z",
- "current_playing_slide_number": -2147483648,
- "current_playing_step_number": -2147483648,
- "slide_state_version": -9223372036854776000,
- "screen_share_layout": "FLOATING",
- "simulive_video_switch_source_map": null,
- "medialive_channel_data": null,
- "sort_priority": -2147483648,
- "medialive_channel_state": "CREATING",
- "wordly_session_id": "string",
- "wordly_session_key": "string",
- "stage_logo_spec": null,
- "lower_third_spec": null,
- "validar_guid": "string",
- "simulive_test_run_end_time": "2019-08-24T14:15:22Z",
- "round_videos": true,
- "show_active_speaker_only": true,
- "is_available_on_demand": true,
- "overlay_text": "string",
- "show_overlay": true,
- "ticker_text": "string",
- "show_ticker": true,
- "slido_poll_embed_url": "string",
- "slido_qa_embed_url": "string",
- "content_repurposing_enabled": true,
- "on_demand_recording_published": true,
- "ppt_task_launch_time": "2019-08-24T14:15:22Z",
- "use_medialive_channel": true,
- "slide_asset_viewer_state": "NOT_INITIATED",
- "run_of_show_config": null,
- "on_demand_run_of_show_config": null,
- "is_automated_run_of_show": true,
- "recording_studio_state": "NOT_INITIALIZED",
- "session_language": "string",
- "local_recording_fps": -2147483648,
- "use_pure_cloud_recording": true,
- "enable_live_run_of_show": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "current_playing_video_asset": "4b45101d-061c-40ce-8e5b-239db1b819e1",
- "current_playing_slide_asset": "8f60b14a-43b8-4a76-a448-5777c97995c0",
- "medialive_rtmp_input": "2c54919a-4f4a-4171-aa51-9df3526b4ecb",
- "sign_language_translator_user_id": "7df3698b-558d-424f-a5ec-002e323b163e",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "speakers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "staffs": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}| id required | string <uuid> A UUID string identifying this broadcast. |
{- "id": "string",
- "text": "string",
- "type": "string",
- "status": "string",
- "answers": [
- {
- "id": "string",
- "text": "string"
}
]
}| id required | string <uuid> A UUID string identifying this broadcast. |
| text required | string non-empty |
| type required | string non-empty |
required | Array of objects (AnswersRequest) |
{- "text": "string",
- "type": "string",
- "answers": [
- {
- "text": "string"
}
]
}{- "id": "string",
- "text": "string",
- "type": "string",
- "status": "string",
- "answers": [
- {
- "id": "string",
- "text": "string"
}
]
}| id required | string <uuid> A UUID string identifying this broadcast. |
| id required | string non-empty |
| text required | string non-empty |
| type required | string non-empty |
required | Array of objects (EditAnswersRequest) |
{- "id": "string",
- "text": "string",
- "type": "string",
- "answers": [
- {
- "id": "string",
- "text": "string"
}
]
}{- "id": "string",
- "text": "string",
- "type": "string",
- "status": "string",
- "answers": [
- {
- "id": "string",
- "text": "string"
}
]
}Request body is an object of the following format
{"questions": [q1_id, q2_id, ...]}
| id required | string <uuid> A UUID string identifying this broadcast. |
{- "id": "string",
- "text": "string",
- "type": "string",
- "status": "string",
- "answers": [
- {
- "id": "string",
- "text": "string"
}
]
}| capacity | integer |
| current | boolean |
| description | string |
| event | string <uuid> |
| is_booth | boolean |
| is_breakout | boolean |
| limit | integer Number of results to return per page. |
| mine | boolean |
| offset | integer The initial index from which to return the results. |
| ordering | string Which field to use when ordering the results. |
| owner | string |
| recommended | Array of strings Multiple values may be separated by commas. |
| search | string A search term. |
| tags | string |
| title | string |
{- "count": 123,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "rank": -2147483648,
- "title": "string",
- "description": "string",
- "recording": null,
- "capacity": -2147483648,
- "sponsor_image": "string",
- "tags": [
- "string"
], - "mmid": "string",
- "shadow_mmid": "string",
- "starts_at": "2019-08-24T14:15:22Z",
- "ends_at": "2019-08-24T14:15:22Z",
- "is_live": true,
- "is_booth": true,
- "is_breakout": true,
- "current": true,
- "video_quality": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}
]
}| rank | integer [ -2147483648 .. 2147483647 ] |
| title required | string [ 1 .. 550 ] characters |
| description | string or null |
| recording | any or null |
| capacity required | integer [ -2147483648 .. 2147483647 ] |
| sponsor_image | string or null <= 500 characters |
| tags | Array of strings or null[ items [ 1 .. 63 ] characters ] |
| mmid | string or null <= 26 characters |
| shadow_mmid | string or null <= 26 characters |
| starts_at | string or null <date-time> |
| ends_at | string or null <date-time> |
| is_live | boolean |
| is_booth | boolean |
| is_breakout | boolean |
| current | boolean |
| video_quality | string or null <= 15 characters |
| event required | string <uuid> |
| owner | string or null <uuid> |
{- "rank": -2147483648,
- "title": "string",
- "description": "string",
- "recording": null,
- "capacity": -2147483648,
- "sponsor_image": "string",
- "tags": [
- "string"
], - "mmid": "string",
- "shadow_mmid": "string",
- "starts_at": "2019-08-24T14:15:22Z",
- "ends_at": "2019-08-24T14:15:22Z",
- "is_live": true,
- "is_booth": true,
- "is_breakout": true,
- "current": true,
- "video_quality": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "rank": -2147483648,
- "title": "string",
- "description": "string",
- "recording": null,
- "capacity": -2147483648,
- "sponsor_image": "string",
- "tags": [
- "string"
], - "mmid": "string",
- "shadow_mmid": "string",
- "starts_at": "2019-08-24T14:15:22Z",
- "ends_at": "2019-08-24T14:15:22Z",
- "is_live": true,
- "is_booth": true,
- "is_breakout": true,
- "current": true,
- "video_quality": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}| id required | string <uuid> A UUID string identifying this discussion group. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "rank": -2147483648,
- "title": "string",
- "description": "string",
- "recording": null,
- "capacity": -2147483648,
- "sponsor_image": "string",
- "tags": [
- "string"
], - "mmid": "string",
- "shadow_mmid": "string",
- "starts_at": "2019-08-24T14:15:22Z",
- "ends_at": "2019-08-24T14:15:22Z",
- "is_live": true,
- "is_booth": true,
- "is_breakout": true,
- "current": true,
- "video_quality": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}| id required | string <uuid> A UUID string identifying this discussion group. |
| rank | integer [ -2147483648 .. 2147483647 ] |
| title required | string [ 1 .. 550 ] characters |
| description | string or null |
| recording | any or null |
| capacity required | integer [ -2147483648 .. 2147483647 ] |
| sponsor_image | string or null <= 500 characters |
| tags | Array of strings or null[ items [ 1 .. 63 ] characters ] |
| mmid | string or null <= 26 characters |
| shadow_mmid | string or null <= 26 characters |
| starts_at | string or null <date-time> |
| ends_at | string or null <date-time> |
| is_live | boolean |
| is_booth | boolean |
| is_breakout | boolean |
| current | boolean |
| video_quality | string or null <= 15 characters |
| event required | string <uuid> |
| owner | string or null <uuid> |
{- "rank": -2147483648,
- "title": "string",
- "description": "string",
- "recording": null,
- "capacity": -2147483648,
- "sponsor_image": "string",
- "tags": [
- "string"
], - "mmid": "string",
- "shadow_mmid": "string",
- "starts_at": "2019-08-24T14:15:22Z",
- "ends_at": "2019-08-24T14:15:22Z",
- "is_live": true,
- "is_booth": true,
- "is_breakout": true,
- "current": true,
- "video_quality": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "rank": -2147483648,
- "title": "string",
- "description": "string",
- "recording": null,
- "capacity": -2147483648,
- "sponsor_image": "string",
- "tags": [
- "string"
], - "mmid": "string",
- "shadow_mmid": "string",
- "starts_at": "2019-08-24T14:15:22Z",
- "ends_at": "2019-08-24T14:15:22Z",
- "is_live": true,
- "is_booth": true,
- "is_breakout": true,
- "current": true,
- "video_quality": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}| id required | string <uuid> A UUID string identifying this discussion group. |
| rank | integer [ -2147483648 .. 2147483647 ] |
| title | string [ 1 .. 550 ] characters |
| description | string or null |
| recording | any or null |
| capacity | integer [ -2147483648 .. 2147483647 ] |
| sponsor_image | string or null <= 500 characters |
| tags | Array of strings or null[ items [ 1 .. 63 ] characters ] |
| mmid | string or null <= 26 characters |
| shadow_mmid | string or null <= 26 characters |
| starts_at | string or null <date-time> |
| ends_at | string or null <date-time> |
| is_live | boolean |
| is_booth | boolean |
| is_breakout | boolean |
| current | boolean |
| video_quality | string or null <= 15 characters |
| event | string <uuid> |
| owner | string or null <uuid> |
{- "rank": -2147483648,
- "title": "string",
- "description": "string",
- "recording": null,
- "capacity": -2147483648,
- "sponsor_image": "string",
- "tags": [
- "string"
], - "mmid": "string",
- "shadow_mmid": "string",
- "starts_at": "2019-08-24T14:15:22Z",
- "ends_at": "2019-08-24T14:15:22Z",
- "is_live": true,
- "is_booth": true,
- "is_breakout": true,
- "current": true,
- "video_quality": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "rank": -2147483648,
- "title": "string",
- "description": "string",
- "recording": null,
- "capacity": -2147483648,
- "sponsor_image": "string",
- "tags": [
- "string"
], - "mmid": "string",
- "shadow_mmid": "string",
- "starts_at": "2019-08-24T14:15:22Z",
- "ends_at": "2019-08-24T14:15:22Z",
- "is_live": true,
- "is_booth": true,
- "is_breakout": true,
- "current": true,
- "video_quality": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}| attended | boolean |
| blocked | boolean |
| checked_in | boolean |
| created_at_gte | string <date-time> Created After |
| created_at_lte | string <date-time> Created Before |
| entered | boolean |
| event | string <uuid> |
| event_role | number |
| kind | Array of strings or null[ items ] Items Enum: "vip" "customer" "prospect" "newlead"
|
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| ordering | string Which field to use when ordering the results. |
| recommended | Array of strings Multiple values may be separated by commas. |
| search | string A search term. |
| status | string Enum: "Canceled" "Registered" "Rejected" "Waitlisted" Status of the user in the event
|
| tags | string |
| updated_at_gte | string <date-time> Updated After |
| updated_at_lte | string <date-time> Updated Before |
| user | string <uuid> |
| user__company | string |
| user__email | string |
| user__email_contains | string |
| user__first_name | string |
| user__last_name | string |
| user__title | string |
| user__username | string |
| utm_medium | string |
{- "count": 123,
- "results": [
- {
- "id": 0,
- "magic_link_url": "string",
- "qrcode_encoding": "string",
- "vivenu_ticket_url": "string",
- "event_role": "string",
- "event_role_list": [
- 0
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "identification_tag": [
- "string"
], - "tags": [
- "string"
], - "registrant_type": "string",
- "badge_id": "string",
- "salesperson_email": "string",
- "customer_message": "string",
- "props": null,
- "pronouns": "string",
- "feedback": "string",
- "is_engaged": true,
- "code_of_conduct": true,
- "privacy_policy": true,
- "health_and_safety_policy": true,
- "data_share_consent": true,
- "utm_campaign": "string",
- "utm_source": "string",
- "utm_medium": "string",
- "utm_content": "string",
- "utm_term": "string",
- "utm_creative": "string",
- "utm_keyword": "string",
- "utm_region": "string",
- "visa_required": true,
- "dietary_restrictions": "string",
- "accessibility": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "attended": "2019-08-24T14:15:22Z",
- "entered": "2019-08-24T14:15:22Z",
- "kind": [
- "vip"
], - "demo_requested": true,
- "quality_rating": 1,
- "quality_rating_timestamp": "2019-08-24T14:15:22Z",
- "is_in_person": true,
- "external_demo_requested": true,
- "external_demo_requested_at": "2019-08-24T14:15:22Z",
- "salesforce_member_id": "string",
- "marketo_lead_id": "string",
- "blocked": true,
- "magic_link": "string",
- "qrcode_content": "string",
- "qrcode": "9632c8e7-59d0-49a0-9b95-0be025923b9a",
- "view_as_attendee": true,
- "event_hub_link": "string",
- "attendance_status": 0,
- "session_attendance": null,
- "on_demand_attended_time": "2019-08-24T14:15:22Z",
- "in_person_attended_time": "2019-08-24T14:15:22Z",
- "status": "Registered",
- "attended_ondemand_unverified": "2019-08-24T14:15:22Z",
- "cta_clicked_unverified": "2019-08-24T14:15:22Z",
- "event_notes": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "user": "76f62a58-5404-486d-9afc-07bded328704",
- "track": "97d4c73d-78bf-4aef-b604-7edb657e1e57",
- "organization_user": "4224e776-ca66-44b0-9b96-1fe0ded21f69",
- "blocked_by": "10746971-fc78-4594-aa5d-0982b01bf10d",
- "status_updated_by": "95b5ca39-2340-4f43-9210-9885a3a6cb87"
}
]
}| id required | integer A unique integer value identifying this event users. |
{- "id": 0,
- "magic_link_url": "string",
- "qrcode_encoding": "string",
- "vivenu_ticket_url": "string",
- "event_role": "string",
- "event_role_list": [
- 0
], - "booth_activities": [
- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "cta_clicked": "2019-08-24T14:15:22Z",
- "booth": "9d5e597e-1320-4cad-b454-0e4d6f544b16",
- "event_user": 0
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "identification_tag": [
- "string"
], - "tags": [
- "string"
], - "registrant_type": "string",
- "badge_id": "string",
- "salesperson_email": "string",
- "customer_message": "string",
- "props": null,
- "pronouns": "string",
- "feedback": "string",
- "is_engaged": true,
- "code_of_conduct": true,
- "privacy_policy": true,
- "health_and_safety_policy": true,
- "data_share_consent": true,
- "utm_campaign": "string",
- "utm_source": "string",
- "utm_medium": "string",
- "utm_content": "string",
- "utm_term": "string",
- "utm_creative": "string",
- "utm_keyword": "string",
- "utm_region": "string",
- "visa_required": true,
- "dietary_restrictions": "string",
- "accessibility": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "attended": "2019-08-24T14:15:22Z",
- "entered": "2019-08-24T14:15:22Z",
- "kind": [
- "vip"
], - "demo_requested": true,
- "quality_rating": 1,
- "quality_rating_timestamp": "2019-08-24T14:15:22Z",
- "is_in_person": true,
- "external_demo_requested": true,
- "external_demo_requested_at": "2019-08-24T14:15:22Z",
- "salesforce_member_id": "string",
- "marketo_lead_id": "string",
- "blocked": true,
- "magic_link": "string",
- "qrcode_content": "string",
- "qrcode": "9632c8e7-59d0-49a0-9b95-0be025923b9a",
- "view_as_attendee": true,
- "event_hub_link": "string",
- "attendance_status": 0,
- "session_attendance": null,
- "on_demand_attended_time": "2019-08-24T14:15:22Z",
- "in_person_attended_time": "2019-08-24T14:15:22Z",
- "status": "Registered",
- "attended_ondemand_unverified": "2019-08-24T14:15:22Z",
- "cta_clicked_unverified": "2019-08-24T14:15:22Z",
- "event_notes": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "user": "76f62a58-5404-486d-9afc-07bded328704",
- "track": "97d4c73d-78bf-4aef-b604-7edb657e1e57",
- "organization_user": "4224e776-ca66-44b0-9b96-1fe0ded21f69",
- "blocked_by": "10746971-fc78-4594-aa5d-0982b01bf10d",
- "status_updated_by": "95b5ca39-2340-4f43-9210-9885a3a6cb87"
}| event required | string <uuid> |
required | object (SponsorUserRequest) |
{- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "user": {
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string",
- "company": "string"
}
}{- "id": 0,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string",
- "company": "string"
}
}| event | string <uuid> |
| key_or_url | string |
| limit | integer Number of results to return per page. |
| name | string |
| object_id | string <uuid> |
| objects | Array of strings Multiple values may be separated by commas. |
| offset | integer The initial index from which to return the results. |
| ordering | string Which field to use when ordering the results. |
| s3hosted | boolean |
| search | string A search term. |
{- "count": 123,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content_type": "string",
- "content_object": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
]
}| content_type required | string (Python model class name) non-empty |
| created_at | string or null <date-time> |
| name required | string [ 1 .. 127 ] characters |
| object_id | string or null <uuid> |
| key_or_url required | string [ 1 .. 1024 ] characters |
| s3hosted | boolean |
| event required | string <uuid> |
{- "content_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content_type": "string",
- "content_object": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}| id required | string <uuid> A UUID string identifying this resource. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content_type": "string",
- "content_object": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}| id required | string <uuid> A UUID string identifying this resource. |
| content_type required | string (Python model class name) non-empty |
| created_at | string or null <date-time> |
| name required | string [ 1 .. 127 ] characters |
| object_id | string or null <uuid> |
| key_or_url required | string [ 1 .. 1024 ] characters |
| s3hosted | boolean |
| event required | string <uuid> |
{- "content_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content_type": "string",
- "content_object": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}| id required | string <uuid> A UUID string identifying this resource. |
| content_type | string (Python model class name) non-empty |
| created_at | string or null <date-time> |
| name | string [ 1 .. 127 ] characters |
| object_id | string or null <uuid> |
| key_or_url | string [ 1 .. 1024 ] characters |
| s3hosted | boolean |
| event | string <uuid> |
{- "content_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content_type": "string",
- "content_object": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}| id required | string <uuid> A UUID string identifying this booth. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resources": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content_type": "string",
- "content_object": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
], - "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "rank": -2147483648,
- "name": "string",
- "description": "string",
- "logo": "string",
- "poster": "string",
- "tags": [
- "string"
], - "hero_asset": "string",
- "hero_asset_type": "hero_asset_video",
- "cta": "string",
- "mmid": "string",
- "demo_request_title": "string",
- "demo_request_message": "string",
- "demo_request_enabled": true,
- "demo_request_button_text": "string",
- "tier": "TIER1",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "discussion_group": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}| id required | string <uuid> A UUID string identifying this booth. |
Array of objects (ResourceRequest) | |
| event required | string <uuid> |
| email required | string <email> non-empty |
| rank | integer [ -2147483648 .. 2147483647 ] |
| name required | string [ 1 .. 127 ] characters |
| description | string or null |
| logo | string or null <= 1024 characters |
| sponsor_link | string or null <uri> <= 1024 characters |
| poster | string or null <= 1024 characters |
| tags | Array of strings or null[ items [ 1 .. 31 ] characters ] |
| hero_asset | string or null <= 500 characters |
(HeroAssetTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| cta | string or null <= 500 characters |
| mmid | string [ 1 .. 26 ] characters |
| demo_request_title | string or null <= 500 characters |
| demo_request_message | string or null |
| demo_request_enabled | boolean |
| demo_request_button_text | string or null <= 500 characters |
| vcapture_url | string or null <uri> <= 1024 characters Validar's vCapture url to award points to attendees |
| tier | string Enum: "TIER1" "TIER2" "TIER3" Decides how booth will be displayed on frontend with Tier1 being the biggest display banner
|
| moderator | Array of strings <uuid> [ items <uuid > ] |
| discussion_group | Array of strings <uuid> [ items <uuid > ] |
{- "resources": [
- {
- "content_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
], - "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "email": "user@example.com",
- "rank": -2147483648,
- "name": "string",
- "description": "string",
- "logo": "string",
- "poster": "string",
- "tags": [
- "string"
], - "hero_asset": "string",
- "hero_asset_type": "hero_asset_video",
- "cta": "string",
- "mmid": "string",
- "demo_request_title": "string",
- "demo_request_message": "string",
- "demo_request_enabled": true,
- "demo_request_button_text": "string",
- "tier": "TIER1",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "discussion_group": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resources": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content_type": "string",
- "content_object": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
], - "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "rank": -2147483648,
- "name": "string",
- "description": "string",
- "logo": "string",
- "poster": "string",
- "tags": [
- "string"
], - "hero_asset": "string",
- "hero_asset_type": "hero_asset_video",
- "cta": "string",
- "mmid": "string",
- "demo_request_title": "string",
- "demo_request_message": "string",
- "demo_request_enabled": true,
- "demo_request_button_text": "string",
- "tier": "TIER1",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "discussion_group": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}| id required | string <uuid> A UUID string identifying this booth. |
Array of objects (ResourceRequest) | |
| event | string <uuid> |
string <email> non-empty | |
| rank | integer [ -2147483648 .. 2147483647 ] |
| name | string [ 1 .. 127 ] characters |
| description | string or null |
| logo | string or null <= 1024 characters |
| sponsor_link | string or null <uri> <= 1024 characters |
| poster | string or null <= 1024 characters |
| tags | Array of strings or null[ items [ 1 .. 31 ] characters ] |
| hero_asset | string or null <= 500 characters |
(HeroAssetTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| cta | string or null <= 500 characters |
| mmid | string [ 1 .. 26 ] characters |
| demo_request_title | string or null <= 500 characters |
| demo_request_message | string or null |
| demo_request_enabled | boolean |
| demo_request_button_text | string or null <= 500 characters |
| vcapture_url | string or null <uri> <= 1024 characters Validar's vCapture url to award points to attendees |
| tier | string Enum: "TIER1" "TIER2" "TIER3" Decides how booth will be displayed on frontend with Tier1 being the biggest display banner
|
| moderator | Array of strings <uuid> [ items <uuid > ] |
| discussion_group | Array of strings <uuid> [ items <uuid > ] |
{- "resources": [
- {
- "content_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
], - "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "email": "user@example.com",
- "rank": -2147483648,
- "name": "string",
- "description": "string",
- "logo": "string",
- "poster": "string",
- "tags": [
- "string"
], - "hero_asset": "string",
- "hero_asset_type": "hero_asset_video",
- "cta": "string",
- "mmid": "string",
- "demo_request_title": "string",
- "demo_request_message": "string",
- "demo_request_enabled": true,
- "demo_request_button_text": "string",
- "tier": "TIER1",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "discussion_group": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resources": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content_type": "string",
- "content_object": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
], - "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "rank": -2147483648,
- "name": "string",
- "description": "string",
- "logo": "string",
- "poster": "string",
- "tags": [
- "string"
], - "hero_asset": "string",
- "hero_asset_type": "hero_asset_video",
- "cta": "string",
- "mmid": "string",
- "demo_request_title": "string",
- "demo_request_message": "string",
- "demo_request_enabled": true,
- "demo_request_button_text": "string",
- "tier": "TIER1",
- "moderator": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "discussion_group": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}| event required | string <uuid> |
| created_at | string or null <date-time> |
| name required | string [ 1 .. 127 ] characters |
| object_id | string or null <uuid> |
| key_or_url required | string [ 1 .. 1024 ] characters |
| s3hosted | boolean |
{- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content_object": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true
}| id required | string <uuid> A UUID string identifying this resource. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content_object": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true
}| id required | string <uuid> A UUID string identifying this resource. |
| event required | string <uuid> |
| created_at | string or null <date-time> |
| name required | string [ 1 .. 127 ] characters |
| object_id | string or null <uuid> |
| key_or_url required | string [ 1 .. 1024 ] characters |
| s3hosted | boolean |
{- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content_object": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true
}| id required | string <uuid> A UUID string identifying this resource. |
| event | string <uuid> |
| created_at | string or null <date-time> |
| name | string [ 1 .. 127 ] characters |
| object_id | string or null <uuid> |
| key_or_url | string [ 1 .. 1024 ] characters |
| s3hosted | boolean |
{- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "content_object": "string",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
- "key_or_url": "string",
- "s3hosted": true
}| event | string <uuid> |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
{- "count": 123,
- "results": [
- {
- "id": 0,
- "allowed_tracks": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "member_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "code": "string",
- "label": "string",
- "allow_all_tracks": true,
- "ticket_type_id": "string",
- "category_name": "string",
- "category_ref_id": "f708ec85-27c5-4551-a545-e8a29cbb6667",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
]
}| allowed_tracks | Array of strings <uuid> [ items <uuid > ] |
| created_at | string or null <date-time> |
| label required | string or null <= 255 characters |
| allow_all_tracks | boolean If set, return all Event Tracks in Uber Response. |
| ticket_type_id | string or null [ 1 .. 24 ] characters One-One map with Vivenu Ticket Type |
| category_name | string or null [ 1 .. 128 ] characters Stores Vivenu Ticket Category Name |
| category_ref_id | string or null <uuid> One-One map with Vivenu Ticket Category Id |
| event required | string <uuid> |
{- "allowed_tracks": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "created_at": "2019-08-24T14:15:22Z",
- "label": "string",
- "allow_all_tracks": true,
- "ticket_type_id": "string",
- "category_name": "string",
- "category_ref_id": "f708ec85-27c5-4551-a545-e8a29cbb6667",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}{- "id": 0,
- "allowed_tracks": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "code": "string",
- "label": "string",
- "allow_all_tracks": true,
- "ticket_type_id": "string",
- "category_name": "string",
- "category_ref_id": "f708ec85-27c5-4551-a545-e8a29cbb6667",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}| id required | integer A unique integer value identifying this ticket type. |
{- "id": 0,
- "allowed_tracks": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "code": "string",
- "label": "string",
- "allow_all_tracks": true,
- "ticket_type_id": "string",
- "category_name": "string",
- "category_ref_id": "f708ec85-27c5-4551-a545-e8a29cbb6667",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}| id required | integer A unique integer value identifying this ticket type. |
| allowed_tracks | Array of strings <uuid> [ items <uuid > ] |
| created_at | string or null <date-time> |
| label required | string or null <= 255 characters |
| allow_all_tracks | boolean If set, return all Event Tracks in Uber Response. |
| ticket_type_id | string or null [ 1 .. 24 ] characters One-One map with Vivenu Ticket Type |
| category_name | string or null [ 1 .. 128 ] characters Stores Vivenu Ticket Category Name |
| category_ref_id | string or null <uuid> One-One map with Vivenu Ticket Category Id |
| event required | string <uuid> |
{- "allowed_tracks": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "created_at": "2019-08-24T14:15:22Z",
- "label": "string",
- "allow_all_tracks": true,
- "ticket_type_id": "string",
- "category_name": "string",
- "category_ref_id": "f708ec85-27c5-4551-a545-e8a29cbb6667",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}{- "id": 0,
- "allowed_tracks": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "code": "string",
- "label": "string",
- "allow_all_tracks": true,
- "ticket_type_id": "string",
- "category_name": "string",
- "category_ref_id": "f708ec85-27c5-4551-a545-e8a29cbb6667",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}| id required | integer A unique integer value identifying this ticket type. |
| allowed_tracks | Array of strings <uuid> [ items <uuid > ] |
| created_at | string or null <date-time> |
| label | string or null <= 255 characters |
| allow_all_tracks | boolean If set, return all Event Tracks in Uber Response. |
| ticket_type_id | string or null [ 1 .. 24 ] characters One-One map with Vivenu Ticket Type |
| category_name | string or null [ 1 .. 128 ] characters Stores Vivenu Ticket Category Name |
| category_ref_id | string or null <uuid> One-One map with Vivenu Ticket Category Id |
{- "allowed_tracks": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "created_at": "2019-08-24T14:15:22Z",
- "label": "string",
- "allow_all_tracks": true,
- "ticket_type_id": "string",
- "category_name": "string",
- "category_ref_id": "f708ec85-27c5-4551-a545-e8a29cbb6667"
}{- "id": 0,
- "allowed_tracks": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "code": "string",
- "label": "string",
- "allow_all_tracks": true,
- "ticket_type_id": "string",
- "category_name": "string",
- "category_ref_id": "f708ec85-27c5-4551-a545-e8a29cbb6667",
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}| custom | boolean |
| event | string <uuid> |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| ordering | string Which field to use when ordering the results. |
{- "count": 123,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "allowed_ticket_types": [
- 0
], - "agenda_items": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom": true,
- "title": "string",
- "channel_mmid": "string",
- "sort_priority": -2147483648,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
]
}| allowed_ticket_types | Array of integers |
| custom | boolean |
| title | string [ 1 .. 128 ] characters |
| channel_mmid | string or null <= 26 characters |
| sort_priority | integer [ -2147483648 .. 2147483647 ] |
| event required | string <uuid> |
{- "allowed_ticket_types": [
- 0
], - "custom": true,
- "title": "string",
- "channel_mmid": "string",
- "sort_priority": -2147483648,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "allowed_ticket_types": [
- 0
], - "agenda_items": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom": true,
- "title": "string",
- "channel_mmid": "string",
- "sort_priority": -2147483648,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}| id required | string <uuid> A UUID string identifying this track. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "allowed_ticket_types": [
- 0
], - "agenda_items": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom": true,
- "title": "string",
- "channel_mmid": "string",
- "sort_priority": -2147483648,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}| id required | string <uuid> A UUID string identifying this track. |
| allowed_ticket_types | Array of integers |
| custom | boolean |
| title | string [ 1 .. 128 ] characters |
| channel_mmid | string or null <= 26 characters |
| sort_priority | integer [ -2147483648 .. 2147483647 ] |
| event required | string <uuid> |
{- "allowed_ticket_types": [
- 0
], - "custom": true,
- "title": "string",
- "channel_mmid": "string",
- "sort_priority": -2147483648,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "allowed_ticket_types": [
- 0
], - "agenda_items": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom": true,
- "title": "string",
- "channel_mmid": "string",
- "sort_priority": -2147483648,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}| id required | string <uuid> A UUID string identifying this track. |
| allowed_ticket_types | Array of integers |
| custom | boolean |
| title | string [ 1 .. 128 ] characters |
| channel_mmid | string or null <= 26 characters |
| sort_priority | integer [ -2147483648 .. 2147483647 ] |
| event | string <uuid> |
{- "allowed_ticket_types": [
- 0
], - "custom": true,
- "title": "string",
- "channel_mmid": "string",
- "sort_priority": -2147483648,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "allowed_ticket_types": [
- 0
], - "agenda_items": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "custom": true,
- "title": "string",
- "channel_mmid": "string",
- "sort_priority": -2147483648,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}| broadcast_type required | string (BroadcastTypeCc6Enum) Enum: "LIVE_HYBRID" "LIVE_EXTERNAL" "SIMULIVE"
|
Array of objects (PollQuestionBroadcastRequest) | |
| hide_watcher_count | boolean Default: true |
| show_watcher_count_speakers | boolean Default: true |
| have_video_qna | boolean Default: false |
| start_time required | string <date-time> |
| end_time required | string <date-time> |
| timezone required | string non-empty |
| default_language | string [ 1 .. 6 ] characters field to select the language for an event |
| is_test | boolean |
| owner | string <uuid> |
| organization | string <uuid> |
| event_type | string Default: "Conference" Enum: "Webinar" "Conference" "Recording"
|
| theme_obj | any |
| broadcast_chat_disabled | boolean Default: true |
| show_booths | boolean Default: false |
| show_agenda | boolean Default: false |
| is_available_on_demand | boolean Allows organizers to set an event to be delivered on-demand 24 hrs after event ends. Needs to be set 1 hr before event starts along with record_broadcasts and record_discussion_groups. |
| registration_page_no_agenda | boolean |
| disable_enter_event_button | boolean |
| speaker_tab_title | string or null <= 255 characters Alternative text for default text of Speakers tab (GS-3869) |
| people_tab_title | string or null <= 255 characters |
| show_people_tab_speakers | boolean Decides if people tab is enabled for speakers/organizers |
| show_answerers_identity | boolean Decide whether to show answerers identity in QnA |
| textqna_answerers_alias | string or null Decide whether to show answerers alias in QnA |
| created_by | string or null <uuid> The user that created this entry |
| updated_by | string or null <uuid> The user that created updated this entry |
| workspace | string or null <uuid> |
| title required | string [ 1 .. 255 ] characters |
| description | string or null |
{- "broadcast_type": "LIVE_HYBRID",
- "polls": [
- {
- "text": "string",
- "type": "SINGLE",
- "answers": [
- {
- "text": "string",
- "id": "string"
}
], - "id": "string"
}
], - "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "have_video_qna": false,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "timezone": "string",
- "default_language": "string",
- "is_test": true,
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "event_type": "Conference",
- "theme_obj": null,
- "broadcast_chat_disabled": true,
- "show_booths": false,
- "show_agenda": false,
- "is_available_on_demand": true,
- "registration_page_no_agenda": true,
- "disable_enter_event_button": true,
- "speaker_tab_title": "string",
- "people_tab_title": "string",
- "show_people_tab_speakers": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
- "title": "string",
- "description": "string"
}{- "broadcast_type": "LIVE_HYBRID",
- "broadcast_id": "c16084dc-339f-49f5-a0b0-07be04eb19a8",
- "title": "string",
- "description": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "timezone": "string",
- "default_language": "en",
- "is_test": true,
- "video_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "slide_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "speakers": [
- {
- "id": 0,
- "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string",
- "title": "string",
- "profile_picture_url": "string",
- "company": "string",
- "description": "string",
- "tech_check": {
- "os": "string",
- "browser": "string",
- "browser_perms": true,
- "connection_speed": 0.1,
- "vpn_ad_blocker": true,
- "browser_tabs": true,
- "screenshare": true,
- "success": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "broadcasts": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "event_app_role": 0,
- "organization_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "profile_picture_url": "string",
- "description": "string",
- "company": "string",
- "title": "string",
- "extra_data": null,
- "location": null,
- "age": -2147483648,
- "phone_number": "string",
- "industry": "string",
- "street_address": "string",
- "address_line_2": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "zip_code": "string",
- "allow_admin_panel_notifications": true,
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "user": "76f62a58-5404-486d-9afc-07bded328704"
}, - "permission_roles": [
- {
- "role": {
- "id": 0,
- "permissions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "user_count": 0,
- "seat_type": "string",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "realm": "studio_app",
- "description": "string",
- "role_group": "Speaker Roles",
- "is_custom": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "broadcasts": [
- null
]
}
], - "send_calendar_invite": true,
- "send_email_invite": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "role": 2,
- "hidden": true,
- "rank": 2147483647,
- "stage_rank": 2147483647,
- "allow_screen_share": true,
- "allow_polls_control": true,
- "allow_moderate_qna": true,
- "allow_moderate_chat": true,
- "allow_share_media": true,
- "allow_share_slides": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
], - "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "record_broadcasts": true,
- "have_video_qna": true,
- "have_text_qna": true,
- "is_text_qna_moderated": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "show_attendees": true,
- "show_attendee_profiles": true,
- "speaker_tab_visible": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "registration_page_no_agenda": true,
- "show_onboarding": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "polls": [
- {
- "text": "string",
- "type": "SINGLE",
- "answers": [
- {
- "text": "string",
- "id": "string"
}
], - "id": "string"
}
], - "disable_enter_event_button": true,
- "speaker_tab_title": "string",
- "people_tab_title": "string",
- "show_people_tab_speakers": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string"
}| id required | string <uuid> A UUID string identifying this event. |
{- "broadcast_type": "LIVE_HYBRID",
- "broadcast_id": "c16084dc-339f-49f5-a0b0-07be04eb19a8",
- "title": "string",
- "description": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "timezone": "string",
- "default_language": "en",
- "is_test": true,
- "video_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "slide_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "speakers": [
- {
- "id": 0,
- "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string",
- "title": "string",
- "profile_picture_url": "string",
- "company": "string",
- "description": "string",
- "tech_check": {
- "os": "string",
- "browser": "string",
- "browser_perms": true,
- "connection_speed": 0.1,
- "vpn_ad_blocker": true,
- "browser_tabs": true,
- "screenshare": true,
- "success": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "broadcasts": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "event_app_role": 0,
- "organization_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "profile_picture_url": "string",
- "description": "string",
- "company": "string",
- "title": "string",
- "extra_data": null,
- "location": null,
- "age": -2147483648,
- "phone_number": "string",
- "industry": "string",
- "street_address": "string",
- "address_line_2": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "zip_code": "string",
- "allow_admin_panel_notifications": true,
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "user": "76f62a58-5404-486d-9afc-07bded328704"
}, - "permission_roles": [
- {
- "role": {
- "id": 0,
- "permissions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "user_count": 0,
- "seat_type": "string",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "realm": "studio_app",
- "description": "string",
- "role_group": "Speaker Roles",
- "is_custom": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "broadcasts": [
- null
]
}
], - "send_calendar_invite": true,
- "send_email_invite": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "role": 2,
- "hidden": true,
- "rank": 2147483647,
- "stage_rank": 2147483647,
- "allow_screen_share": true,
- "allow_polls_control": true,
- "allow_moderate_qna": true,
- "allow_moderate_chat": true,
- "allow_share_media": true,
- "allow_share_slides": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
], - "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "record_broadcasts": true,
- "have_video_qna": true,
- "have_text_qna": true,
- "is_text_qna_moderated": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "show_attendees": true,
- "show_attendee_profiles": true,
- "speaker_tab_visible": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "registration_page_no_agenda": true,
- "show_onboarding": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "polls": [
- {
- "text": "string",
- "type": "SINGLE",
- "answers": [
- {
- "text": "string",
- "id": "string"
}
], - "id": "string"
}
], - "disable_enter_event_button": true,
- "speaker_tab_title": "string",
- "people_tab_title": "string",
- "show_people_tab_speakers": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string"
}| id required | string <uuid> A UUID string identifying this event. |
| broadcast_type required | string (BroadcastTypeCc6Enum) Enum: "LIVE_HYBRID" "LIVE_EXTERNAL" "SIMULIVE"
|
| broadcast_id required | string <uuid> |
| title required | string non-empty |
| description required | string non-empty |
| start_time required | string <date-time> |
| end_time required | string <date-time> |
| timezone required | string non-empty |
| default_language required | string (DefaultLanguageEnum) Enum: "en" "es" "zh" "ja" "ko" "de" "it" "fr" "nl" "pt" "pl" "ru" "tr" "th" "vi" "hr" "zh-TW" "es-MX" "da" "sv" "no" "fi" "hu" "cs" "ar"
|
| is_test required | boolean |
| video_assets required | Array of strings <uuid> [ items <uuid > ] |
| slide_assets required | Array of strings <uuid> [ items <uuid > ] |
Array of objects (ResourceBroadcastRequestRequest) | |
required | Array of objects (WebinarSpeakerRequest) |
| public_chat_disabled required | boolean |
| thread_chat_disabled required | boolean |
| record_broadcasts required | boolean |
| have_video_qna required | boolean |
| have_text_qna required | boolean |
| is_text_qna_moderated required | boolean |
| enable_live_captions required | boolean |
| enable_live_captions_translations required | boolean |
| show_attendees required | boolean |
| show_attendee_profiles required | boolean |
| speaker_tab_visible required | boolean |
| hide_watcher_count required | boolean |
| show_watcher_count_speakers required | boolean |
| registration_page_no_agenda required | boolean |
| show_onboarding required | boolean |
| is_available_on_demand required | boolean |
| on_demand_mode required | boolean |
| youtube_live_url required | string non-empty |
| facebook_live_url required | string non-empty |
| youtube_stream_key required | string non-empty |
| facebook_stream_key required | string non-empty |
| custom_stream_url required | string non-empty |
| custom_stream_key required | string non-empty |
Array of objects (PollQuestionBroadcastRequest) | |
| disable_enter_event_button required | boolean |
| speaker_tab_title required | string non-empty |
| people_tab_title required | string non-empty |
| show_people_tab_speakers required | boolean |
| show_answerers_identity required | boolean |
| textqna_answerers_alias required | string non-empty |
{- "broadcast_type": "LIVE_HYBRID",
- "broadcast_id": "c16084dc-339f-49f5-a0b0-07be04eb19a8",
- "title": "string",
- "description": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "timezone": "string",
- "default_language": "en",
- "is_test": true,
- "video_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "slide_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "speakers": [
- {
- "user": {
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string",
- "title": "string",
- "profile_picture_url": "string",
- "company": "string",
- "description": "string"
}, - "broadcasts": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "event_app_role": 0,
- "send_calendar_invite": true,
- "send_email_invite": true,
- "created_at": "2019-08-24T14:15:22Z",
- "hidden": true,
- "rank": 2147483647,
- "stage_rank": 2147483647,
- "allow_screen_share": true,
- "allow_polls_control": true,
- "allow_moderate_qna": true,
- "allow_moderate_chat": true,
- "allow_share_media": true,
- "allow_share_slides": true
}
], - "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "record_broadcasts": true,
- "have_video_qna": true,
- "have_text_qna": true,
- "is_text_qna_moderated": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "show_attendees": true,
- "show_attendee_profiles": true,
- "speaker_tab_visible": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "registration_page_no_agenda": true,
- "show_onboarding": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "polls": [
- {
- "text": "string",
- "type": "SINGLE",
- "answers": [
- {
- "text": "string",
- "id": "string"
}
], - "id": "string"
}
], - "disable_enter_event_button": true,
- "speaker_tab_title": "string",
- "people_tab_title": "string",
- "show_people_tab_speakers": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string"
}{- "broadcast_type": "LIVE_HYBRID",
- "broadcast_id": "c16084dc-339f-49f5-a0b0-07be04eb19a8",
- "title": "string",
- "description": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "timezone": "string",
- "default_language": "en",
- "is_test": true,
- "video_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "slide_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "speakers": [
- {
- "id": 0,
- "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string",
- "title": "string",
- "profile_picture_url": "string",
- "company": "string",
- "description": "string",
- "tech_check": {
- "os": "string",
- "browser": "string",
- "browser_perms": true,
- "connection_speed": 0.1,
- "vpn_ad_blocker": true,
- "browser_tabs": true,
- "screenshare": true,
- "success": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "broadcasts": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "event_app_role": 0,
- "organization_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "profile_picture_url": "string",
- "description": "string",
- "company": "string",
- "title": "string",
- "extra_data": null,
- "location": null,
- "age": -2147483648,
- "phone_number": "string",
- "industry": "string",
- "street_address": "string",
- "address_line_2": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "zip_code": "string",
- "allow_admin_panel_notifications": true,
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "user": "76f62a58-5404-486d-9afc-07bded328704"
}, - "permission_roles": [
- {
- "role": {
- "id": 0,
- "permissions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "user_count": 0,
- "seat_type": "string",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "realm": "studio_app",
- "description": "string",
- "role_group": "Speaker Roles",
- "is_custom": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "broadcasts": [
- null
]
}
], - "send_calendar_invite": true,
- "send_email_invite": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "role": 2,
- "hidden": true,
- "rank": 2147483647,
- "stage_rank": 2147483647,
- "allow_screen_share": true,
- "allow_polls_control": true,
- "allow_moderate_qna": true,
- "allow_moderate_chat": true,
- "allow_share_media": true,
- "allow_share_slides": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
], - "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "record_broadcasts": true,
- "have_video_qna": true,
- "have_text_qna": true,
- "is_text_qna_moderated": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "show_attendees": true,
- "show_attendee_profiles": true,
- "speaker_tab_visible": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "registration_page_no_agenda": true,
- "show_onboarding": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "polls": [
- {
- "text": "string",
- "type": "SINGLE",
- "answers": [
- {
- "text": "string",
- "id": "string"
}
], - "id": "string"
}
], - "disable_enter_event_button": true,
- "speaker_tab_title": "string",
- "people_tab_title": "string",
- "show_people_tab_speakers": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string"
}| id required | string <uuid> A UUID string identifying this event. |
| broadcast_type | string (BroadcastTypeCc6Enum) Enum: "LIVE_HYBRID" "LIVE_EXTERNAL" "SIMULIVE"
|
| broadcast_id | string <uuid> |
| title | string non-empty |
| description | string non-empty |
| start_time | string <date-time> |
| end_time | string <date-time> |
| timezone | string non-empty |
| default_language | string (DefaultLanguageEnum) Enum: "en" "es" "zh" "ja" "ko" "de" "it" "fr" "nl" "pt" "pl" "ru" "tr" "th" "vi" "hr" "zh-TW" "es-MX" "da" "sv" "no" "fi" "hu" "cs" "ar"
|
| is_test | boolean |
| video_assets | Array of strings <uuid> [ items <uuid > ] |
| slide_assets | Array of strings <uuid> [ items <uuid > ] |
Array of objects (ResourceBroadcastRequestRequest) | |
Array of objects (WebinarSpeakerRequest) | |
| public_chat_disabled | boolean |
| thread_chat_disabled | boolean |
| record_broadcasts | boolean |
| have_video_qna | boolean |
| have_text_qna | boolean |
| is_text_qna_moderated | boolean |
| enable_live_captions | boolean |
| enable_live_captions_translations | boolean |
| show_attendees | boolean |
| show_attendee_profiles | boolean |
| speaker_tab_visible | boolean |
| hide_watcher_count | boolean |
| show_watcher_count_speakers | boolean |
| registration_page_no_agenda | boolean |
| show_onboarding | boolean |
| is_available_on_demand | boolean |
| on_demand_mode | boolean |
| youtube_live_url | string non-empty |
| facebook_live_url | string non-empty |
| youtube_stream_key | string non-empty |
| facebook_stream_key | string non-empty |
| custom_stream_url | string non-empty |
| custom_stream_key | string non-empty |
Array of objects (PollQuestionBroadcastRequest) | |
| disable_enter_event_button | boolean |
| speaker_tab_title | string non-empty |
| people_tab_title | string non-empty |
| show_people_tab_speakers | boolean |
| show_answerers_identity | boolean |
| textqna_answerers_alias | string non-empty |
{- "broadcast_type": "LIVE_HYBRID",
- "broadcast_id": "c16084dc-339f-49f5-a0b0-07be04eb19a8",
- "title": "string",
- "description": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "timezone": "string",
- "default_language": "en",
- "is_test": true,
- "video_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "slide_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "speakers": [
- {
- "user": {
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string",
- "title": "string",
- "profile_picture_url": "string",
- "company": "string",
- "description": "string"
}, - "broadcasts": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "event_app_role": 0,
- "send_calendar_invite": true,
- "send_email_invite": true,
- "created_at": "2019-08-24T14:15:22Z",
- "hidden": true,
- "rank": 2147483647,
- "stage_rank": 2147483647,
- "allow_screen_share": true,
- "allow_polls_control": true,
- "allow_moderate_qna": true,
- "allow_moderate_chat": true,
- "allow_share_media": true,
- "allow_share_slides": true
}
], - "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "record_broadcasts": true,
- "have_video_qna": true,
- "have_text_qna": true,
- "is_text_qna_moderated": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "show_attendees": true,
- "show_attendee_profiles": true,
- "speaker_tab_visible": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "registration_page_no_agenda": true,
- "show_onboarding": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "polls": [
- {
- "text": "string",
- "type": "SINGLE",
- "answers": [
- {
- "text": "string",
- "id": "string"
}
], - "id": "string"
}
], - "disable_enter_event_button": true,
- "speaker_tab_title": "string",
- "people_tab_title": "string",
- "show_people_tab_speakers": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string"
}{- "broadcast_type": "LIVE_HYBRID",
- "broadcast_id": "c16084dc-339f-49f5-a0b0-07be04eb19a8",
- "title": "string",
- "description": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "timezone": "string",
- "default_language": "en",
- "is_test": true,
- "video_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "slide_assets": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "resources": [
- {
- "key_or_url": "string",
- "name": "string",
- "s3hosted": true
}
], - "speakers": [
- {
- "id": 0,
- "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string",
- "title": "string",
- "profile_picture_url": "string",
- "company": "string",
- "description": "string",
- "tech_check": {
- "os": "string",
- "browser": "string",
- "browser_perms": true,
- "connection_speed": 0.1,
- "vpn_ad_blocker": true,
- "browser_tabs": true,
- "screenshare": true,
- "success": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "broadcasts": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "event_app_role": 0,
- "organization_user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "profile_picture_url": "string",
- "description": "string",
- "company": "string",
- "title": "string",
- "extra_data": null,
- "location": null,
- "age": -2147483648,
- "phone_number": "string",
- "industry": "string",
- "street_address": "string",
- "address_line_2": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "zip_code": "string",
- "allow_admin_panel_notifications": true,
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "user": "76f62a58-5404-486d-9afc-07bded328704"
}, - "permission_roles": [
- {
- "role": {
- "id": 0,
- "permissions": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "user_count": 0,
- "seat_type": "string",
- "deleted": "2019-08-24T14:15:22Z",
- "deleted_by_cascade": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "realm": "studio_app",
- "description": "string",
- "role_group": "Speaker Roles",
- "is_custom": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387"
}, - "broadcasts": [
- null
]
}
], - "send_calendar_invite": true,
- "send_email_invite": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "role": 2,
- "hidden": true,
- "rank": 2147483647,
- "stage_rank": 2147483647,
- "allow_screen_share": true,
- "allow_polls_control": true,
- "allow_moderate_qna": true,
- "allow_moderate_chat": true,
- "allow_share_media": true,
- "allow_share_slides": true,
- "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}
], - "public_chat_disabled": true,
- "thread_chat_disabled": true,
- "record_broadcasts": true,
- "have_video_qna": true,
- "have_text_qna": true,
- "is_text_qna_moderated": true,
- "enable_live_captions": true,
- "enable_live_captions_translations": true,
- "show_attendees": true,
- "show_attendee_profiles": true,
- "speaker_tab_visible": true,
- "hide_watcher_count": true,
- "show_watcher_count_speakers": true,
- "registration_page_no_agenda": true,
- "show_onboarding": true,
- "is_available_on_demand": true,
- "on_demand_mode": true,
- "youtube_live_url": "string",
- "facebook_live_url": "string",
- "youtube_stream_key": "string",
- "facebook_stream_key": "string",
- "custom_stream_url": "string",
- "custom_stream_key": "string",
- "polls": [
- {
- "text": "string",
- "type": "SINGLE",
- "answers": [
- {
- "text": "string",
- "id": "string"
}
], - "id": "string"
}
], - "disable_enter_event_button": true,
- "speaker_tab_title": "string",
- "people_tab_title": "string",
- "show_people_tab_speakers": true,
- "show_answerers_identity": true,
- "textqna_answerers_alias": "string"
}