Goldcast External API (1.0.0)

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)

Organization

List organization

Authorizations:
Token AuthenticationX-Cvent-Authorization
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

Retrieve organization

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this organization.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "workspace_settings": {
    },
  • "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",
  • "drift_url": "http://example.com",
  • "salesforce_base_url": "http://example.com",
  • "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": [
    ],
  • "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": [
    ],
  • "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"
}

Tag library

List tag library

API endpoint that allows tags to library to be edited, deleted or added

Authorizations:
Token AuthenticationX-Cvent-Authorization
query Parameters
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

Responses

Response samples

Content type
application/json
{}

Retrieve tag library

API endpoint that allows tags to library to be edited, deleted or added

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this tag library.

Responses

Response samples

Content type
application/json
{
  • "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"
}

User

Event

List events

Authorizations:
Token AuthenticationX-Cvent-Authorization
query Parameters
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

  • Webinar - Webinar
  • Conference - Conference
  • Recording - Recording
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

  • default - Default
  • repeating - Repeating
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

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

Create event

Cvent Security Role: events:write

Cvent Auth Methods: bearer

Authorizations:
Token AuthenticationX-Cvent-Authorization
Request Body schema:
required
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"
  • Webinar - Webinar
  • Conference - Conference
  • Recording - Recording
broadcast_type
string
Default: "LIVE_HYBRID"
Enum: "LIVE" "LIVE_EXTERNAL" "LIVE_HYBRID" "LIVE_EXTERNAL_HYBRID" "SIMULIVE" "INHOUSE_SIMULIVE" "HYBRID_SIMULIVE" "IN_PERSON_HYBRID"
  • LIVE - LIVE
  • LIVE_EXTERNAL - LIVE_EXTERNAL
  • LIVE_HYBRID - LIVE_HYBRID
  • LIVE_EXTERNAL_HYBRID - LIVE_EXTERNAL_HYBRID
  • SIMULIVE - SIMULIVE
  • INHOUSE_SIMULIVE - INHOUSE_SIMULIVE
  • HYBRID_SIMULIVE - HYBRID_SIMULIVE
  • IN_PERSON_HYBRID - 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"
  • user_delete - user_delete
  • look_and_feel_update - look_and_feel_update
  • registration_page_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

  • INVITE_SPEAKER - Invite Speaker
  • PUSH_SPEAKER - Push Speaker
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

  • ASK_TO_UNMUTE - Ask To Unmute
  • DIRECT_UNMUTE - Direct Unmute
(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.

  • ONE_CLICK - One Click
  • TWO_STEP - Two Step
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"
  • PROCESSING - PROCESSING
  • STOPPED - STOPPED
  • ERRORED - 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

  • default - default
  • grapejs - grapejs
  • newbuilder - newbuilder
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

  • Hybrid - Hybrid
  • Virtual - Virtual
  • In_Person - In_Person
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

  • IDLE - Idle
  • IN_PROGRESS - In Progress
  • FAILED - Failed
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

  • NONE - None
  • FORCE_ENDED - Force 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

  • zh-CN - Chinese (Simplified, China)
  • zh-TW - Chinese (Traditional, Taiwan)
  • en-US - English (United States)
  • en-GB - English (United Kingdom)
  • en-AU - English (Australia)
  • en-IN - English (India)
  • de-DE - German (Germany)
  • ja-JA - Japanese (Japan)
  • es-ES - Spanish (Spain)
  • ko-KR - Korean (South Korea)
  • fr-FR - French (France)
  • fr-CA - French (Canada)
  • nl-NL - Dutch (Netherlands)
  • pt-PT - Portuguese (Portugal)
  • tr-TR - Turkish (Turkey)
  • ru-RU - Russian (Russia)
  • it-IT - Italian (Italy)
  • th-TH - Thai (Thailand)
  • vi-VN - Vietnamese (Vietnam)
  • hr-HR - Croatian (Croatia)
  • pl-PL - Polish (Poland)
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"
  • PUBLIC - PUBLIC
  • PRIVATE - PRIVATE
  • OFF - 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>

Responses

Request samples

Content type
{
  • "timezone": "string",
  • "csv_data": "string",
  • "track_order": [
    ],
  • "ticker_url": "http://example.com",
  • "is_single_session": false,
  • "event_tags": {
    },
  • "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,
  • "logo_url": "http://example.com",
  • "favicon": "http://example.com",
  • "show_discussion_rooms": true,
  • "title": "string",
  • "description": "string",
  • "theme_obj": null,
  • "default_language": "string",
  • "enable_booth_tiers": true,
  • "social_media_thumbnail": "http://example.com",
  • "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,
  • "banner_url": "http://example.com",
  • "landing_image_url": "http://example.com",
  • "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": [
    ],
  • "mail_reminder_intervals": [
    ],
  • "is_active": true,
  • "preview_image_url": "http://example.com",
  • "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_url": "http://example.com",
  • "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_leaderboard_url": "http://example.com",
  • "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,
  • "recorder_event_app_domain": "http://example.com",
  • "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",
  • "registration_app_domain": "http://example.com",
  • "on_demand_app_url": "http://example.com",
  • "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": [
    ],
  • "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"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "timezone": "string",
  • "csv_data": "string",
  • "manual_breakout": true,
  • "supported_languages": [
    ],
  • "events_app_languages": [
    ],
  • "vivenu_event_url": "string",
  • "ticker_url": "http://example.com",
  • "is_single_session": false,
  • "created_by_user": {
    },
  • "updated_by_user": {
    },
  • "splash_tracking_pixel_snippet": {
    },
  • "registrant_count": "string",
  • "registration_cta_link": "string",
  • "event_type": "Conference",
  • "broadcast_type": "LIVE_HYBRID",
  • "event_creation_source": "goldcast",
  • "metadata": {
    },
  • "recording_state": "string",
  • "registration_form_data": {
    },
  • "cvent_event_id": "string",
  • "cvent_environment": "string",
  • "series": {
    },
  • "tags": [
    ],
  • "workspace": {
    },
  • "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,
  • "logo_url": "http://example.com",
  • "favicon": "http://example.com",
  • "show_discussion_rooms": true,
  • "title": "string",
  • "description": "string",
  • "theme_obj": null,
  • "default_language": "string",
  • "enable_booth_tiers": true,
  • "social_media_thumbnail": "http://example.com",
  • "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,
  • "banner_url": "http://example.com",
  • "landing_image_url": "http://example.com",
  • "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": [
    ],
  • "mail_reminder_intervals": [
    ],
  • "is_active": true,
  • "is_hybrid": true,
  • "preview_image_url": "http://example.com",
  • "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_url": "http://example.com",
  • "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_leaderboard_url": "http://example.com",
  • "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,
  • "recorder_event_app_domain": "http://example.com",
  • "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",
  • "registration_app_domain": "http://example.com",
  • "on_demand_app_url": "http://example.com",
  • "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": [
    ],
  • "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"
}

Update event

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this event.

Request Body schema:
required
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"
  • Webinar - Webinar
  • Conference - Conference
  • Recording - Recording
broadcast_type
string
Default: "LIVE_HYBRID"
Enum: "LIVE" "LIVE_EXTERNAL" "LIVE_HYBRID" "LIVE_EXTERNAL_HYBRID" "SIMULIVE" "INHOUSE_SIMULIVE" "HYBRID_SIMULIVE" "IN_PERSON_HYBRID"
  • LIVE - LIVE
  • LIVE_EXTERNAL - LIVE_EXTERNAL
  • LIVE_HYBRID - LIVE_HYBRID
  • LIVE_EXTERNAL_HYBRID - LIVE_EXTERNAL_HYBRID
  • SIMULIVE - SIMULIVE
  • INHOUSE_SIMULIVE - INHOUSE_SIMULIVE
  • HYBRID_SIMULIVE - HYBRID_SIMULIVE
  • IN_PERSON_HYBRID - 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"
  • user_delete - user_delete
  • look_and_feel_update - look_and_feel_update
  • registration_page_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

  • INVITE_SPEAKER - Invite Speaker
  • PUSH_SPEAKER - Push Speaker
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

  • ASK_TO_UNMUTE - Ask To Unmute
  • DIRECT_UNMUTE - Direct Unmute
(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.

  • ONE_CLICK - One Click
  • TWO_STEP - Two Step
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"
  • PROCESSING - PROCESSING
  • STOPPED - STOPPED
  • ERRORED - 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

  • default - default
  • grapejs - grapejs
  • newbuilder - newbuilder
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

  • Hybrid - Hybrid
  • Virtual - Virtual
  • In_Person - In_Person
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

  • IDLE - Idle
  • IN_PROGRESS - In Progress
  • FAILED - Failed
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

  • NONE - None
  • FORCE_ENDED - Force 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

  • zh-CN - Chinese (Simplified, China)
  • zh-TW - Chinese (Traditional, Taiwan)
  • en-US - English (United States)
  • en-GB - English (United Kingdom)
  • en-AU - English (Australia)
  • en-IN - English (India)
  • de-DE - German (Germany)
  • ja-JA - Japanese (Japan)
  • es-ES - Spanish (Spain)
  • ko-KR - Korean (South Korea)
  • fr-FR - French (France)
  • fr-CA - French (Canada)
  • nl-NL - Dutch (Netherlands)
  • pt-PT - Portuguese (Portugal)
  • tr-TR - Turkish (Turkey)
  • ru-RU - Russian (Russia)
  • it-IT - Italian (Italy)
  • th-TH - Thai (Thailand)
  • vi-VN - Vietnamese (Vietnam)
  • hr-HR - Croatian (Croatia)
  • pl-PL - Polish (Poland)
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"
  • PUBLIC - PUBLIC
  • PRIVATE - PRIVATE
  • OFF - 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>

Responses

Request samples

Content type
{
  • "timezone": "string",
  • "csv_data": "string",
  • "track_order": [
    ],
  • "ticker_url": "http://example.com",
  • "is_single_session": false,
  • "event_tags": {
    },
  • "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,
  • "logo_url": "http://example.com",
  • "favicon": "http://example.com",
  • "show_discussion_rooms": true,
  • "title": "string",
  • "description": "string",
  • "theme_obj": null,
  • "default_language": "string",
  • "enable_booth_tiers": true,
  • "social_media_thumbnail": "http://example.com",
  • "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,
  • "banner_url": "http://example.com",
  • "landing_image_url": "http://example.com",
  • "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": [
    ],
  • "mail_reminder_intervals": [
    ],
  • "is_active": true,
  • "preview_image_url": "http://example.com",
  • "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_url": "http://example.com",
  • "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_leaderboard_url": "http://example.com",
  • "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,
  • "recorder_event_app_domain": "http://example.com",
  • "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",
  • "registration_app_domain": "http://example.com",
  • "on_demand_app_url": "http://example.com",
  • "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": [
    ],
  • "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"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "timezone": "string",
  • "csv_data": "string",
  • "manual_breakout": true,
  • "supported_languages": [
    ],
  • "events_app_languages": [
    ],
  • "vivenu_event_url": "string",
  • "ticker_url": "http://example.com",
  • "is_single_session": false,
  • "created_by_user": {
    },
  • "updated_by_user": {
    },
  • "splash_tracking_pixel_snippet": {
    },
  • "registrant_count": "string",
  • "registration_cta_link": "string",
  • "event_type": "Conference",
  • "broadcast_type": "LIVE_HYBRID",
  • "event_creation_source": "goldcast",
  • "metadata": {
    },
  • "recording_state": "string",
  • "registration_form_data": {
    },
  • "cvent_event_id": "string",
  • "cvent_environment": "string",
  • "series": {
    },
  • "tags": [
    ],
  • "workspace": {
    },
  • "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,
  • "logo_url": "http://example.com",
  • "favicon": "http://example.com",
  • "show_discussion_rooms": true,
  • "title": "string",
  • "description": "string",
  • "theme_obj": null,
  • "default_language": "string",
  • "enable_booth_tiers": true,
  • "social_media_thumbnail": "http://example.com",
  • "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,
  • "banner_url": "http://example.com",
  • "landing_image_url": "http://example.com",
  • "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": [
    ],
  • "mail_reminder_intervals": [
    ],
  • "is_active": true,
  • "is_hybrid": true,
  • "preview_image_url": "http://example.com",
  • "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_url": "http://example.com",
  • "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_leaderboard_url": "http://example.com",
  • "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,
  • "recorder_event_app_domain": "http://example.com",
  • "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",
  • "registration_app_domain": "http://example.com",
  • "on_demand_app_url": "http://example.com",
  • "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": [
    ],
  • "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"
}

Partial update event

Cvent Security Role: events:write

Cvent Auth Methods: bearer

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this event.

Request Body schema:
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"
  • Webinar - Webinar
  • Conference - Conference
  • Recording - Recording
broadcast_type
string
Default: "LIVE_HYBRID"
Enum: "LIVE" "LIVE_EXTERNAL" "LIVE_HYBRID" "LIVE_EXTERNAL_HYBRID" "SIMULIVE" "INHOUSE_SIMULIVE" "HYBRID_SIMULIVE" "IN_PERSON_HYBRID"
  • LIVE - LIVE
  • LIVE_EXTERNAL - LIVE_EXTERNAL
  • LIVE_HYBRID - LIVE_HYBRID
  • LIVE_EXTERNAL_HYBRID - LIVE_EXTERNAL_HYBRID
  • SIMULIVE - SIMULIVE
  • INHOUSE_SIMULIVE - INHOUSE_SIMULIVE
  • HYBRID_SIMULIVE - HYBRID_SIMULIVE
  • IN_PERSON_HYBRID - 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"
  • user_delete - user_delete
  • look_and_feel_update - look_and_feel_update
  • registration_page_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

  • INVITE_SPEAKER - Invite Speaker
  • PUSH_SPEAKER - Push Speaker
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

  • ASK_TO_UNMUTE - Ask To Unmute
  • DIRECT_UNMUTE - Direct Unmute
(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.

  • ONE_CLICK - One Click
  • TWO_STEP - Two Step
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"
  • PROCESSING - PROCESSING
  • STOPPED - STOPPED
  • ERRORED - 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

  • default - default
  • grapejs - grapejs
  • newbuilder - newbuilder
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

  • Hybrid - Hybrid
  • Virtual - Virtual
  • In_Person - In_Person
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

  • IDLE - Idle
  • IN_PROGRESS - In Progress
  • FAILED - Failed
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

  • NONE - None
  • FORCE_ENDED - Force 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

  • zh-CN - Chinese (Simplified, China)
  • zh-TW - Chinese (Traditional, Taiwan)
  • en-US - English (United States)
  • en-GB - English (United Kingdom)
  • en-AU - English (Australia)
  • en-IN - English (India)
  • de-DE - German (Germany)
  • ja-JA - Japanese (Japan)
  • es-ES - Spanish (Spain)
  • ko-KR - Korean (South Korea)
  • fr-FR - French (France)
  • fr-CA - French (Canada)
  • nl-NL - Dutch (Netherlands)
  • pt-PT - Portuguese (Portugal)
  • tr-TR - Turkish (Turkey)
  • ru-RU - Russian (Russia)
  • it-IT - Italian (Italy)
  • th-TH - Thai (Thailand)
  • vi-VN - Vietnamese (Vietnam)
  • hr-HR - Croatian (Croatia)
  • pl-PL - Polish (Poland)
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"
  • PUBLIC - PUBLIC
  • PRIVATE - PRIVATE
  • OFF - 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>

Responses

Request samples

Content type
{
  • "timezone": "string",
  • "csv_data": "string",
  • "track_order": [
    ],
  • "ticker_url": "http://example.com",
  • "is_single_session": false,
  • "event_tags": {
    },
  • "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,
  • "logo_url": "http://example.com",
  • "favicon": "http://example.com",
  • "show_discussion_rooms": true,
  • "title": "string",
  • "description": "string",
  • "theme_obj": null,
  • "default_language": "string",
  • "enable_booth_tiers": true,
  • "social_media_thumbnail": "http://example.com",
  • "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,
  • "banner_url": "http://example.com",
  • "landing_image_url": "http://example.com",
  • "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": [
    ],
  • "mail_reminder_intervals": [
    ],
  • "is_active": true,
  • "preview_image_url": "http://example.com",
  • "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_url": "http://example.com",
  • "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_leaderboard_url": "http://example.com",
  • "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,
  • "recorder_event_app_domain": "http://example.com",
  • "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",
  • "registration_app_domain": "http://example.com",
  • "on_demand_app_url": "http://example.com",
  • "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": [
    ],
  • "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"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "timezone": "string",
  • "csv_data": "string",
  • "manual_breakout": true,
  • "supported_languages": [
    ],
  • "events_app_languages": [
    ],
  • "vivenu_event_url": "string",
  • "ticker_url": "http://example.com",
  • "is_single_session": false,
  • "created_by_user": {
    },
  • "updated_by_user": {
    },
  • "splash_tracking_pixel_snippet": {
    },
  • "registrant_count": "string",
  • "registration_cta_link": "string",
  • "event_type": "Conference",
  • "broadcast_type": "LIVE_HYBRID",
  • "event_creation_source": "goldcast",
  • "metadata": {
    },
  • "recording_state": "string",
  • "registration_form_data": {
    },
  • "cvent_event_id": "string",
  • "cvent_environment": "string",
  • "series": {
    },
  • "tags": [
    ],
  • "workspace": {
    },
  • "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,
  • "logo_url": "http://example.com",
  • "favicon": "http://example.com",
  • "show_discussion_rooms": true,
  • "title": "string",
  • "description": "string",
  • "theme_obj": null,
  • "default_language": "string",
  • "enable_booth_tiers": true,
  • "social_media_thumbnail": "http://example.com",
  • "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,
  • "banner_url": "http://example.com",
  • "landing_image_url": "http://example.com",
  • "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": [
    ],
  • "mail_reminder_intervals": [
    ],
  • "is_active": true,
  • "is_hybrid": true,
  • "preview_image_url": "http://example.com",
  • "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_url": "http://example.com",
  • "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_leaderboard_url": "http://example.com",
  • "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,
  • "recorder_event_app_domain": "http://example.com",
  • "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",
  • "registration_app_domain": "http://example.com",
  • "on_demand_app_url": "http://example.com",
  • "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": [
    ],
  • "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"
}

Delete event

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this event.

Responses

Event's Agenda

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this event.

Responses

Response samples

Content type
application/json
{
  • "broadcast": [
    ],
  • "items": [
    ]
}

Duplicate event

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this event.

Request Body schema:
required
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

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "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
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "timezone": "string",
  • "csv_data": "string",
  • "manual_breakout": true,
  • "supported_languages": [
    ],
  • "events_app_languages": [
    ],
  • "vivenu_event_url": "string",
  • "ticker_url": "http://example.com",
  • "is_single_session": false,
  • "created_by_user": {
    },
  • "updated_by_user": {
    },
  • "splash_tracking_pixel_snippet": {
    },
  • "registrant_count": "string",
  • "registration_cta_link": "string",
  • "event_type": "Conference",
  • "broadcast_type": "LIVE_HYBRID",
  • "event_creation_source": "goldcast",
  • "metadata": {
    },
  • "recording_state": "string",
  • "registration_form_data": {
    },
  • "cvent_event_id": "string",
  • "cvent_environment": "string",
  • "series": {
    },
  • "tags": [
    ],
  • "workspace": {
    },
  • "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,
  • "logo_url": "http://example.com",
  • "favicon": "http://example.com",
  • "show_discussion_rooms": true,
  • "title": "string",
  • "description": "string",
  • "theme_obj": null,
  • "default_language": "string",
  • "enable_booth_tiers": true,
  • "social_media_thumbnail": "http://example.com",
  • "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,
  • "banner_url": "http://example.com",
  • "landing_image_url": "http://example.com",
  • "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": [
    ],
  • "mail_reminder_intervals": [
    ],
  • "is_active": true,
  • "is_hybrid": true,
  • "preview_image_url": "http://example.com",
  • "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_url": "http://example.com",
  • "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_leaderboard_url": "http://example.com",
  • "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,
  • "recorder_event_app_domain": "http://example.com",
  • "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",
  • "registration_app_domain": "http://example.com",
  • "on_demand_app_url": "http://example.com",
  • "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": [
    ],
  • "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"
}

Get event recordings

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this event.

query Parameters
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

  • Webinar - Webinar
  • Conference - Conference
  • Recording - Recording
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

  • default - Default
  • repeating - Repeating
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

Responses

Response samples

Content type
application/json
{}

Public APIs for Registration Page

Agenda public v1

Get event agenda

Authorizations:
Token AuthenticationX-Cvent-AuthorizationNone
path Parameters
event_id
required
string <uuid>

A UUID string identifying this event.

Responses

Response samples

Content type
application/json
{
  • "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": [
    ]
}

Booths public v1

Get event agenda

Authorizations:
Token AuthenticationX-Cvent-AuthorizationNone
path Parameters
event_id
required
string <uuid>

A UUID string identifying this event.

Responses

Response samples

Content type
application/json
{}

Overview public v1

Get event overview

Authorizations:
Token AuthenticationX-Cvent-AuthorizationNone
path Parameters
event_id
required
string <uuid>

A UUID string identifying this event.

Responses

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "host_type": "Hybrid",
  • "description": "string",
  • "goldcast_reg_page_link": "http://example.com",
  • "favicon": "http://example.com"
}

Speakers public v1

Get event speakers

Authorizations:
Token AuthenticationX-Cvent-AuthorizationNone
path Parameters
event_id
required
string <uuid>

A UUID string identifying this event.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "first_name": "string",
  • "last_name": "string",
  • "title": "string",
  • "profile_picture_url": "string",
  • "company": "string",
  • "linkedin_url": "http://example.com",
  • "twitter_url": "http://example.com",
  • "description": "string"
}

Get events list public

Authorizations:
Token AuthenticationX-Cvent-AuthorizationNone
query Parameters
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.

Responses

Response samples

Content type
application/json
{}

Agenda item

List agenda item

Authorizations:
Token AuthenticationX-Cvent-Authorization
query Parameters
event
string <uuid>
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

Create agenda item

Authorizations:
Token AuthenticationX-Cvent-Authorization
Request Body schema:
required
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"
  • break - Break
  • networking - Networking
  • booth - Booth
  • room - Room
  • booth2 - 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>

Responses

Request samples

Content type
{
  • "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": [
    ],
  • "live_start_time": "2019-08-24T14:15:22Z",
  • "live_end_time": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "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"
}

Retrieve agenda item

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
integer

A unique integer value identifying this agenda item.

Responses

Response samples

Content type
application/json
{
  • "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"
}

Update agenda item

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
integer

A unique integer value identifying this agenda item.

Request Body schema:
required
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"
  • break - Break
  • networking - Networking
  • booth - Booth
  • room - Room
  • booth2 - 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>

Responses

Request samples

Content type
{
  • "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": [
    ],
  • "live_start_time": "2019-08-24T14:15:22Z",
  • "live_end_time": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "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"
}

Partial update agenda item

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
integer

A unique integer value identifying this agenda item.

Request Body schema:
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"
  • break - Break
  • networking - Networking
  • booth - Booth
  • room - Room
  • booth2 - 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>

Responses

Request samples

Content type
{
  • "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": [
    ],
  • "live_start_time": "2019-08-24T14:15:22Z",
  • "live_end_time": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "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"
}

Destroy agenda item

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
integer

A unique integer value identifying this agenda item.

Responses

Booths

List booths

Authorizations:
Token AuthenticationX-Cvent-Authorization
query Parameters
booth_type
string
Enum: "Primary" "Secondary"
  • Primary - Primary
  • Secondary - 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

Responses

Response samples

Content type
application/json
{}

Create booths

Authorizations:
Token AuthenticationX-Cvent-Authorization
Request Body schema:
required
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"
  • Primary - Primary
  • Secondary - 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

  • TIER1 - Tier1
  • TIER2 - Tier2
  • TIER3 - Tier3
event
required
string <uuid>
moderator
Array of strings <uuid> [ items <uuid > ]
discussion_group
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "resources": [
    ],
  • "rank": -2147483648,
  • "name": "string",
  • "description": "string",
  • "booth_type": "Primary",
  • "logo": "string",
  • "sponsor_link": "http://example.com",
  • "poster": "string",
  • "tags": [
    ],
  • "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",
  • "vcapture_url": "http://example.com",
  • "tier": "TIER1",
  • "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
  • "moderator": [
    ],
  • "discussion_group": [
    ]
}

Response samples

Content type
application/json
{}

Retrieve booths

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this booth.

Responses

Response samples

Content type
application/json
{}

Update booths

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this booth.

Request Body schema:
required
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"
  • Primary - Primary
  • Secondary - 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

  • TIER1 - Tier1
  • TIER2 - Tier2
  • TIER3 - Tier3
event
required
string <uuid>
moderator
Array of strings <uuid> [ items <uuid > ]
discussion_group
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "resources": [
    ],
  • "rank": -2147483648,
  • "name": "string",
  • "description": "string",
  • "booth_type": "Primary",
  • "logo": "string",
  • "sponsor_link": "http://example.com",
  • "poster": "string",
  • "tags": [
    ],
  • "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",
  • "vcapture_url": "http://example.com",
  • "tier": "TIER1",
  • "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
  • "moderator": [
    ],
  • "discussion_group": [
    ]
}

Response samples

Content type
application/json
{}

Partial update booths

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this booth.

Request Body schema:
Array of objects (ResourceRequest)
rank
integer [ -2147483648 .. 2147483647 ]
name
string [ 1 .. 127 ] characters
description
string or null
booth_type
string (BoothTypeEnum)
Enum: "Primary" "Secondary"
  • Primary - Primary
  • Secondary - 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

  • TIER1 - Tier1
  • TIER2 - Tier2
  • TIER3 - Tier3
event
string <uuid>
moderator
Array of strings <uuid> [ items <uuid > ]
discussion_group
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "resources": [
    ],
  • "rank": -2147483648,
  • "name": "string",
  • "description": "string",
  • "booth_type": "Primary",
  • "logo": "string",
  • "sponsor_link": "http://example.com",
  • "poster": "string",
  • "tags": [
    ],
  • "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",
  • "vcapture_url": "http://example.com",
  • "tier": "TIER1",
  • "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
  • "moderator": [
    ],
  • "discussion_group": [
    ]
}

Response samples

Content type
application/json
{}

Destroy booths

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this booth.

Responses

Broadcasts

List broadcasts

Cvent Security Role: events:read

Cvent Auth Methods: bearer

Authorizations:
Token AuthenticationX-Cvent-Authorization
query Parameters
broadcast_type
string
Enum: "HYBRID_SIMULIVE" "INHOUSE_SIMULIVE" "IN_PERSON_HYBRID" "LIVE" "LIVE_EXTERNAL" "LIVE_EXTERNAL_HYBRID" "LIVE_HYBRID" "SIMULIVE"
  • LIVE - LIVE
  • LIVE_EXTERNAL - LIVE_EXTERNAL
  • LIVE_HYBRID - LIVE_HYBRID
  • LIVE_EXTERNAL_HYBRID - LIVE_EXTERNAL_HYBRID
  • SIMULIVE - SIMULIVE
  • INHOUSE_SIMULIVE - INHOUSE_SIMULIVE
  • HYBRID_SIMULIVE - HYBRID_SIMULIVE
  • IN_PERSON_HYBRID - IN_PERSON_HYBRID
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

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

Create broadcasts

Authorizations:
Token AuthenticationX-Cvent-Authorization
Request Body schema:
required
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"
  • LIVE - LIVE
  • LIVE_EXTERNAL - LIVE_EXTERNAL
  • LIVE_HYBRID - LIVE_HYBRID
  • LIVE_EXTERNAL_HYBRID - LIVE_EXTERNAL_HYBRID
  • SIMULIVE - SIMULIVE
  • INHOUSE_SIMULIVE - INHOUSE_SIMULIVE
  • HYBRID_SIMULIVE - HYBRID_SIMULIVE
  • IN_PERSON_HYBRID - 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"
  • FLOATING - FLOATING
  • FLEX - FLEX
  • NO_SPEAKER_VIDEOS - NO_SPEAKER_VIDEOS
  • UNDER_SCREEN - UNDER_SCREEN
  • TOP_OF_VIDEO - TOP_OF_VIDEO
  • FLEX_16_9 - 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"
  • CREATING - CREATING
  • CREATE_FAILED - CREATE_FAILED
  • IDLE - IDLE
  • STARTING - STARTING
  • RUNNING - RUNNING
  • RECOVERING - RECOVERING
  • STOPPING - STOPPING
  • STOPPED - STOPPED
  • DELETING - DELETING
  • DELETED - DELETED
  • UPDATING - UPDATING
  • UPDATE_FAILED - UPDATE_FAILED
  • NOT_PRESENT - 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"
  • NOT_INITIATED - NOT_INITIATED
  • INITIATED - INITIATED
  • COMPLETED - COMPLETED
  • RUNNING - RUNNING
  • CLOSED - CLOSED
  • FAILED - 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"
  • NOT_INITIALIZED - NOT_INITIALIZED
  • RECORDING - RECORDING
  • STOPPED - STOPPED
  • PAUSED - PAUSED
  • STARTING - 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 > ]

Responses

Request samples

Content type
{
  • "video_assets": [
    ],
  • "slide_assets": [
    ],
  • "recording_video_asset": "54693be3-d852-4817-9c74-f14d44fe06f5",
  • "custom_ondemand_video_asset": "76e991f1-1c4a-4ed7-9bc5-858ec6e5245a",
  • "polls": [
    ],
  • "tracks": [
    ],
  • "resources": [
    ],
  • "kudo_config": {},
  • "layout_settings": {
    },
  • "ticker_url": "http://example.com",
  • "webinar_config": null,
  • "speaker_role_list": [
    ],
  • "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": [
    ],
  • "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_vcapture_url": "http://example.com",
  • "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_transcript_url": "http://example.com",
  • "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": [
    ],
  • "speakers": [
    ],
  • "staffs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "medialive_rtmp_input_details": {
    },
  • "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": [
    ],
  • "kudo_config": {},
  • "layout_settings": {
    },
  • "ticker_url": "http://example.com",
  • "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": [
    ],
  • "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_vcapture_url": "http://example.com",
  • "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_transcript_url": "http://example.com",
  • "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": [
    ],
  • "speakers": [
    ],
  • "staffs": [
    ]
}

Retrieve broadcast

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this broadcast.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "medialive_rtmp_input_details": {
    },
  • "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": [
    ],
  • "kudo_config": {},
  • "layout_settings": {
    },
  • "ticker_url": "http://example.com",
  • "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": [
    ],
  • "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_vcapture_url": "http://example.com",
  • "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_transcript_url": "http://example.com",
  • "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": [
    ],
  • "speakers": [
    ],
  • "staffs": [
    ]
}

Update broadcasts

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this broadcast.

Request Body schema:
required
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"
  • LIVE - LIVE
  • LIVE_EXTERNAL - LIVE_EXTERNAL
  • LIVE_HYBRID - LIVE_HYBRID
  • LIVE_EXTERNAL_HYBRID - LIVE_EXTERNAL_HYBRID
  • SIMULIVE - SIMULIVE
  • INHOUSE_SIMULIVE - INHOUSE_SIMULIVE
  • HYBRID_SIMULIVE - HYBRID_SIMULIVE
  • IN_PERSON_HYBRID - 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"
  • FLOATING - FLOATING
  • FLEX - FLEX
  • NO_SPEAKER_VIDEOS - NO_SPEAKER_VIDEOS
  • UNDER_SCREEN - UNDER_SCREEN
  • TOP_OF_VIDEO - TOP_OF_VIDEO
  • FLEX_16_9 - 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"
  • CREATING - CREATING
  • CREATE_FAILED - CREATE_FAILED
  • IDLE - IDLE
  • STARTING - STARTING
  • RUNNING - RUNNING
  • RECOVERING - RECOVERING
  • STOPPING - STOPPING
  • STOPPED - STOPPED
  • DELETING - DELETING
  • DELETED - DELETED
  • UPDATING - UPDATING
  • UPDATE_FAILED - UPDATE_FAILED
  • NOT_PRESENT - 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"
  • NOT_INITIATED - NOT_INITIATED
  • INITIATED - INITIATED
  • COMPLETED - COMPLETED
  • RUNNING - RUNNING
  • CLOSED - CLOSED
  • FAILED - 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"
  • NOT_INITIALIZED - NOT_INITIALIZED
  • RECORDING - RECORDING
  • STOPPED - STOPPED
  • PAUSED - PAUSED
  • STARTING - 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 > ]

Responses

Request samples

Content type
{
  • "video_assets": [
    ],
  • "slide_assets": [
    ],
  • "recording_video_asset": "54693be3-d852-4817-9c74-f14d44fe06f5",
  • "custom_ondemand_video_asset": "76e991f1-1c4a-4ed7-9bc5-858ec6e5245a",
  • "polls": [
    ],
  • "tracks": [
    ],
  • "resources": [
    ],
  • "kudo_config": {},
  • "layout_settings": {
    },
  • "ticker_url": "http://example.com",
  • "webinar_config": null,
  • "speaker_role_list": [
    ],
  • "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": [
    ],
  • "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_vcapture_url": "http://example.com",
  • "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_transcript_url": "http://example.com",
  • "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": [
    ],
  • "speakers": [
    ],
  • "staffs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "medialive_rtmp_input_details": {
    },
  • "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": [
    ],
  • "kudo_config": {},
  • "layout_settings": {
    },
  • "ticker_url": "http://example.com",
  • "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": [
    ],
  • "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_vcapture_url": "http://example.com",
  • "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_transcript_url": "http://example.com",
  • "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": [
    ],
  • "speakers": [
    ],
  • "staffs": [
    ]
}

Partial update broadcasts

Cvent Security Role: events:write

Cvent Auth Methods: bearer

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this broadcast.

Request Body schema:
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"
  • LIVE - LIVE
  • LIVE_EXTERNAL - LIVE_EXTERNAL
  • LIVE_HYBRID - LIVE_HYBRID
  • LIVE_EXTERNAL_HYBRID - LIVE_EXTERNAL_HYBRID
  • SIMULIVE - SIMULIVE
  • INHOUSE_SIMULIVE - INHOUSE_SIMULIVE
  • HYBRID_SIMULIVE - HYBRID_SIMULIVE
  • IN_PERSON_HYBRID - 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"
  • FLOATING - FLOATING
  • FLEX - FLEX
  • NO_SPEAKER_VIDEOS - NO_SPEAKER_VIDEOS
  • UNDER_SCREEN - UNDER_SCREEN
  • TOP_OF_VIDEO - TOP_OF_VIDEO
  • FLEX_16_9 - 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"
  • CREATING - CREATING
  • CREATE_FAILED - CREATE_FAILED
  • IDLE - IDLE
  • STARTING - STARTING
  • RUNNING - RUNNING
  • RECOVERING - RECOVERING
  • STOPPING - STOPPING
  • STOPPED - STOPPED
  • DELETING - DELETING
  • DELETED - DELETED
  • UPDATING - UPDATING
  • UPDATE_FAILED - UPDATE_FAILED
  • NOT_PRESENT - 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"
  • NOT_INITIATED - NOT_INITIATED
  • INITIATED - INITIATED
  • COMPLETED - COMPLETED
  • RUNNING - RUNNING
  • CLOSED - CLOSED
  • FAILED - 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"
  • NOT_INITIALIZED - NOT_INITIALIZED
  • RECORDING - RECORDING
  • STOPPED - STOPPED
  • PAUSED - PAUSED
  • STARTING - 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 > ]

Responses

Request samples

Content type
{
  • "video_assets": [
    ],
  • "slide_assets": [
    ],
  • "recording_video_asset": "54693be3-d852-4817-9c74-f14d44fe06f5",
  • "custom_ondemand_video_asset": "76e991f1-1c4a-4ed7-9bc5-858ec6e5245a",
  • "polls": [
    ],
  • "tracks": [
    ],
  • "resources": [
    ],
  • "kudo_config": {},
  • "layout_settings": {
    },
  • "ticker_url": "http://example.com",
  • "webinar_config": null,
  • "speaker_role_list": [
    ],
  • "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": [
    ],
  • "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_vcapture_url": "http://example.com",
  • "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_transcript_url": "http://example.com",
  • "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": [
    ],
  • "speakers": [
    ],
  • "staffs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "medialive_rtmp_input_details": {
    },
  • "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": [
    ],
  • "kudo_config": {},
  • "layout_settings": {
    },
  • "ticker_url": "http://example.com",
  • "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": [
    ],
  • "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_vcapture_url": "http://example.com",
  • "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_transcript_url": "http://example.com",
  • "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": [
    ],
  • "speakers": [
    ],
  • "staffs": [
    ]
}

Destroy broadcasts

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this broadcast.

Responses

Stop recording broadcast

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this broadcast.

Responses

Polls

List polls

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this broadcast.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "text": "string",
  • "type": "string",
  • "status": "string",
  • "answers": [
    ]
}

Create poll

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this broadcast.

Request Body schema:
required
text
required
string non-empty
type
required
string non-empty
required
Array of objects (AnswersRequest)

Responses

Request samples

Content type
{
  • "text": "string",
  • "type": "string",
  • "answers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "text": "string",
  • "type": "string",
  • "status": "string",
  • "answers": [
    ]
}

Update poll

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this broadcast.

Request Body schema:
required
id
required
string non-empty
text
required
string non-empty
type
required
string non-empty
required
Array of objects (EditAnswersRequest)

Responses

Request samples

Content type
{
  • "id": "string",
  • "text": "string",
  • "type": "string",
  • "answers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "text": "string",
  • "type": "string",
  • "status": "string",
  • "answers": [
    ]
}

Delete poll

Request body is an object of the following format

{"questions": [q1_id, q2_id, ...]}
Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this broadcast.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "text": "string",
  • "type": "string",
  • "status": "string",
  • "answers": [
    ]
}

Discussion groups

List discussion groups

Authorizations:
Token AuthenticationX-Cvent-Authorization
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

Create discussion groups

Authorizations:
Token AuthenticationX-Cvent-Authorization
Request Body schema:
required
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>

Responses

Request samples

Content type
{
  • "rank": -2147483648,
  • "title": "string",
  • "description": "string",
  • "recording": null,
  • "capacity": -2147483648,
  • "sponsor_image": "string",
  • "tags": [
    ],
  • "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"
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "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"
}

Retrieve discussion groups

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this discussion group.

Responses

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "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"
}

Update discussion groups

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this discussion group.

Request Body schema:
required
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>

Responses

Request samples

Content type
{
  • "rank": -2147483648,
  • "title": "string",
  • "description": "string",
  • "recording": null,
  • "capacity": -2147483648,
  • "sponsor_image": "string",
  • "tags": [
    ],
  • "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"
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "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"
}

Partial update discussion groups

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this discussion group.

Request Body schema:
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>

Responses

Request samples

Content type
{
  • "rank": -2147483648,
  • "title": "string",
  • "description": "string",
  • "recording": null,
  • "capacity": -2147483648,
  • "sponsor_image": "string",
  • "tags": [
    ],
  • "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"
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "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"
}

Destroy discussion groups

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this discussion group.

Responses

Event members

List event members

Authorizations:
Token AuthenticationX-Cvent-Authorization
query Parameters
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"
  • vip - VIP
  • customer - Customer
  • prospect - Prospect
  • newlead - New Lead
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

  • Registered - Registered
  • Waitlisted - Waitlisted
  • Canceled - Canceled
  • Rejected - Rejected
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

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

Retrieve event members

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
integer

A unique integer value identifying this event users.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "magic_link_url": "string",
  • "qrcode_encoding": "string",
  • "vivenu_ticket_url": "string",
  • "event_role": "string",
  • "event_role_list": [
    ],
  • "booth_activities": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "identification_tag": [
    ],
  • "tags": [
    ],
  • "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": [
    ],
  • "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 sponsor

Resources

List resources

Authorizations:
Token AuthenticationX-Cvent-Authorization
query Parameters
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.

Responses

Response samples

Content type
application/json
{}

Create resources

Authorizations:
Token AuthenticationX-Cvent-Authorization
Request Body schema:
required
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>

Responses

Request samples

Content type
{
  • "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"
}

Response samples

Content type
application/json
{
  • "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"
}

Retrieve resources

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this resource.

Responses

Response samples

Content type
application/json
{
  • "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"
}

Update resources

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this resource.

Request Body schema:
required
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>

Responses

Request samples

Content type
{
  • "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"
}

Response samples

Content type
application/json
{
  • "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"
}

Partial update resources

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this resource.

Request Body schema:
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>

Responses

Request samples

Content type
{
  • "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"
}

Response samples

Content type
application/json
{
  • "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"
}

Destroy resources

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this resource.

Responses

Sponsor booths

Sponsor resources

Ticket type

List ticket type

Authorizations:
Token AuthenticationX-Cvent-Authorization
query Parameters
event
string <uuid>
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

Create ticket type

Authorizations:
Token AuthenticationX-Cvent-Authorization
Request Body schema:
required
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>

Responses

Request samples

Content type
{
  • "allowed_tracks": [
    ],
  • "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"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "allowed_tracks": [
    ],
  • "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"
}

Retrieve ticket type

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
integer

A unique integer value identifying this ticket type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "allowed_tracks": [
    ],
  • "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"
}

Update ticket type

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
integer

A unique integer value identifying this ticket type.

Request Body schema:
required
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>

Responses

Request samples

Content type
{
  • "allowed_tracks": [
    ],
  • "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"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "allowed_tracks": [
    ],
  • "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"
}

Partial update ticket type

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
integer

A unique integer value identifying this ticket type.

Request Body schema:
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

Responses

Request samples

Content type
{
  • "allowed_tracks": [
    ],
  • "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"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "allowed_tracks": [
    ],
  • "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"
}

Destroy ticket type

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
integer

A unique integer value identifying this ticket type.

Responses

Tracks

List tracks

Authorizations:
Token AuthenticationX-Cvent-Authorization
query Parameters
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.

Responses

Response samples

Content type
application/json
{}

Create tracks

Authorizations:
Token AuthenticationX-Cvent-Authorization
Request Body schema:
required
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>

Responses

Request samples

Content type
{
  • "allowed_ticket_types": [
    ],
  • "custom": true,
  • "title": "string",
  • "channel_mmid": "string",
  • "sort_priority": -2147483648,
  • "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "allowed_ticket_types": [
    ],
  • "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"
}

Retrieve tracks

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this track.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "allowed_ticket_types": [
    ],
  • "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"
}

Update tracks

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this track.

Request Body schema:
required
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>

Responses

Request samples

Content type
{
  • "allowed_ticket_types": [
    ],
  • "custom": true,
  • "title": "string",
  • "channel_mmid": "string",
  • "sort_priority": -2147483648,
  • "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "allowed_ticket_types": [
    ],
  • "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"
}

Partial update tracks

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this track.

Request Body schema:
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>

Responses

Request samples

Content type
{
  • "allowed_ticket_types": [
    ],
  • "custom": true,
  • "title": "string",
  • "channel_mmid": "string",
  • "sort_priority": -2147483648,
  • "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "allowed_ticket_types": [
    ],
  • "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"
}

Destroy tracks

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this track.

Responses

Webinars

Create webinars

Authorizations:
Token AuthenticationX-Cvent-Authorization
Request Body schema:
required
broadcast_type
required
string (BroadcastTypeCc6Enum)
Enum: "LIVE_HYBRID" "LIVE_EXTERNAL" "SIMULIVE"
  • LIVE_HYBRID - LIVE_HYBRID
  • LIVE_EXTERNAL - LIVE_EXTERNAL
  • SIMULIVE - 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"
  • Webinar - Webinar
  • Conference - Conference
  • Recording - 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

Responses

Request samples

Content type
{
  • "broadcast_type": "LIVE_HYBRID",
  • "polls": [
    ],
  • "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"
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "slide_assets": [
    ],
  • "resources": [
    ],
  • "speakers": [
    ],
  • "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": [
    ],
  • "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"
}

Retrieve webinars

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this event.

Responses

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "slide_assets": [
    ],
  • "resources": [
    ],
  • "speakers": [
    ],
  • "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": [
    ],
  • "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"
}

Update webinars

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this event.

Request Body schema:
required
broadcast_type
required
string (BroadcastTypeCc6Enum)
Enum: "LIVE_HYBRID" "LIVE_EXTERNAL" "SIMULIVE"
  • LIVE_HYBRID - LIVE_HYBRID
  • LIVE_EXTERNAL - LIVE_EXTERNAL
  • SIMULIVE - 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"
  • en - English___English
  • es - Spanish___Español
  • zh - Chinese___中文
  • ja - Japanese___日本語
  • ko - Korean___한국어
  • de - German___Deutsch
  • it - Italian___Italiano
  • fr - French___Français
  • nl - Dutch___Nederlands
  • pt - Portuguese___Português
  • pl - Polish___Polski
  • ru - Russian___Русский
  • tr - Turkish___Türkçe
  • th - Thai___ไทย
  • vi - Vietnamese___Tiếng Việt
  • hr - Croatian___Hrvatski
  • zh-TW - Traditional Chinese___繁體中文
  • es-MX - Spanish (Mexico)___Español (México)
  • da - Danish___Dansk
  • sv - Swedish___Svenska
  • no - Norwegian___Norsk
  • fi - Finnish___Suomi
  • hu - Hungarian___Magyar
  • cs - Czech___Čeština
  • ar - Arabic___العربية
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

Responses

Request samples

Content type
{
  • "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": [
    ],
  • "slide_assets": [
    ],
  • "resources": [
    ],
  • "speakers": [
    ],
  • "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": [
    ],
  • "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"
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "slide_assets": [
    ],
  • "resources": [
    ],
  • "speakers": [
    ],
  • "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": [
    ],
  • "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"
}

Partial update webinars

Authorizations:
Token AuthenticationX-Cvent-Authorization
path Parameters
id
required
string <uuid>

A UUID string identifying this event.

Request Body schema:
broadcast_type
string (BroadcastTypeCc6Enum)
Enum: "LIVE_HYBRID" "LIVE_EXTERNAL" "SIMULIVE"
  • LIVE_HYBRID - LIVE_HYBRID
  • LIVE_EXTERNAL - LIVE_EXTERNAL
  • SIMULIVE - 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"
  • en - English___English
  • es - Spanish___Español
  • zh - Chinese___中文
  • ja - Japanese___日本語
  • ko - Korean___한국어
  • de - German___Deutsch
  • it - Italian___Italiano
  • fr - French___Français
  • nl - Dutch___Nederlands
  • pt - Portuguese___Português
  • pl - Polish___Polski
  • ru - Russian___Русский
  • tr - Turkish___Türkçe
  • th - Thai___ไทย
  • vi - Vietnamese___Tiếng Việt
  • hr - Croatian___Hrvatski
  • zh-TW - Traditional Chinese___繁體中文
  • es-MX - Spanish (Mexico)___Español (México)
  • da - Danish___Dansk
  • sv - Swedish___Svenska
  • no - Norwegian___Norsk
  • fi - Finnish___Suomi
  • hu - Hungarian___Magyar
  • cs - Czech___Čeština
  • ar - Arabic___العربية
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

Responses

Request samples

Content type
{
  • "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": [
    ],
  • "slide_assets": [
    ],
  • "resources": [
    ],
  • "speakers": [
    ],
  • "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": [
    ],
  • "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"
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "slide_assets": [
    ],
  • "resources": [
    ],
  • "speakers": [
    ],
  • "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": [
    ],
  • "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"
}