{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"topic": {
"type": "string",
"description": "The main topic of the webinar"
},
"type": {
"type": "string",
"enum": [
"Webinar",
"RecurringNoFixedTime",
"RecurringFixedTime",
5,
6,
9
],
"description": "Webinar type: 5 = Webinar, 6 = Recurring webinar (no fixed time), 9 = Recurring webinar (fixed time)"
},
"startTime": {
"type": "string",
"description": "Webinar start time in ISO 8601 format (e.g., \"2024-01-15T10:00:00Z\"). Only for scheduled and/or recurring webinars with fixed time."
},
"duration": {
"type": "number",
"description": "The webinar duration in minutes. Only used for scheduled webinars."
},
"timezone": {
"type": "string",
"description": "The timezone to assign to the start_time value. Only for scheduled or recurring webinars with a fixed time."
},
"agenda": {
"type": "string",
"description": "A description for the webinar"
},
"password": {
"type": "string",
"description": "The webinar passcode (max 10 alphanumeric characters including special characters like !, @, #)"
},
"defaultPasscode": {
"type": "boolean",
"default": true,
"description": "Whether to automatically generate a passcode when none is provided and user Passcode setting is enabled"
},
"scheduleFor": {
"type": "string",
"description": "The email address or user ID of the user for whom the webinar is being scheduled"
},
"templateId": {
"type": "string",
"description": "The ID of a webinar template to use for scheduling"
},
"recurrence": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Daily",
"Weekly",
"Monthly",
1,
2,
3
],
"description": "Recurrence type: 1 = Daily, 2 = Weekly, 3 = Monthly"
},
"repeatInterval": {
"type": "number",
"description": "Interval between recurrences"
},
"endTimes": {
"type": "number",
"description": "Number of times the webinar will recur"
},
"endDateTime": {
"type": "string",
"description": "End date and time for recurring webinar"
},
"weeklyDays": {
"type": "string",
"description": "Days of the week for weekly recurrence (1-7, where 1=Sunday)"
},
"monthlyDay": {
"type": "number",
"description": "Day of the month for monthly recurrence"
},
"monthlyWeek": {
"type": "number",
"description": "Week of the month for monthly recurrence"
},
"monthlyWeekDay": {
"type": "number",
"description": "Day of the week for monthly recurrence"
}
},
"description": "Recurrence settings for recurring webinars of type 9 (fixed time)"
},
"settings": {
"type": "object",
"properties": {
"host_video": {
"type": "boolean",
"description": "Whether to enable host video"
},
"panelists_video": {
"type": "boolean",
"description": "Whether to enable panelists video"
},
"practice_session": {
"type": "boolean",
"description": "Whether to enable practice session"
},
"hd_video": {
"type": "boolean",
"description": "Whether to enable HD video"
},
"hd_video_for_attendees": {
"type": "boolean",
"description": "Whether to enable HD video for attendees"
},
"approval_type": {
"type": "string",
"enum": [
"AutomaticallyApprove",
"ManuallyApprove",
"NoRegistrationRequired",
0,
1,
2
],
"description": "Registration approval type: 0 = Automatically approve, 1 = Manually approve, 2 = No registration required"
},
"registration_type": {
"type": "number",
"description": "Registration type for the webinar"
},
"audio": {
"type": "string",
"enum": [
"both",
"telephony",
"voip",
"thirdParty"
],
"description": "Audio options: both = Computer and telephone, telephony = Telephone only, voip = Computer audio only, thirdParty = Third party audio"
},
"auto_recording": {
"type": "string",
"enum": [
"local",
"cloud",
"none"
],
"description": "Auto recording setting: local = Local recording, cloud = Cloud recording, none = No recording"
},
"enforce_login": {
"type": "boolean",
"description": "Whether to enforce login for the webinar"
},
"allow_multiple_devices": {
"type": "boolean",
"description": "Whether to allow attendees to join from multiple devices"
},
"alternative_hosts": {
"type": "string",
"description": "Alternative host email addresses (semicolon-separated)"
},
"alternative_host_update_polls": {
"type": "boolean",
"description": "Whether alternative hosts can update polls"
},
"audio_conference_info": {
"type": "string",
"description": "Audio conference information"
},
"authentication_domains": {
"type": "string",
"description": "Authentication domains (comma-separated)"
},
"authentication_option": {
"type": "string",
"description": "Authentication option ID"
},
"contact_email": {
"type": "string",
"description": "Contact email for the webinar"
},
"contact_name": {
"type": "string",
"description": "Contact name for the webinar"
},
"email_language": {
"type": "string",
"description": "Email language (e.g., \"en-US\")"
},
"global_dial_in_countries": {
"type": "array",
"items": {
"type": "string"
},
"description": "Global dial-in countries (array of country codes)"
},
"language_interpretation": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"description": "Whether to enable language interpretation"
},
"interpreters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Interpreter email address"
}
}
},
"description": "List of interpreters"
}
},
"description": "Language interpretation settings"
},
"attendees_and_panelists_reminder_email_notification": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"description": "Whether to enable reminder email notifications"
},
"type": {
"type": "number",
"description": "Reminder type"
}
},
"description": "Attendees and panelists reminder email notification settings"
},
"follow_up_absentees_email_notification": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"description": "Whether to enable follow-up email for absentees"
},
"type": {
"type": "number",
"description": "Follow-up type"
}
},
"description": "Follow-up absentees email notification settings"
},
"follow_up_attendees_email_notification": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"description": "Whether to enable follow-up email for attendees"
},
"type": {
"type": "number",
"description": "Follow-up type"
}
},
"description": "Follow-up attendees email notification settings"
}
},
"description": "Optional webinar configuration settings"
},
"tracking_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Tracking field name"
},
"value": {
"type": "string",
"description": "Tracking field value"
}
}
},
"description": "Custom tracking fields for the webinar"
}
},
"required": [
"PCID",
"topic",
"type"
]
}