Manage Webcast Registration Fields
This set of APIs allows developers to manage the set of custom Webcast registration fields defined for Public events that are available for Event Hosts for their Webcasts.
Add Public Webcast Registration Fields
Provides Event Hosts a means to capture attendee details beyond name and email address when hosting Public webcasts. For each custom field created using this endpoint, use the Ids returned in the Create/Edit Webcast APIs (RegistrationFields parameter) to include them in your Webcasts.
POST
/api/v2/accounts/webcast-registration-fields
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| webcastRegistrationField | body | multipart/form-data | Yes |
“Registration Fields” Model Schema
| Name | Type | Description | Required |
|---|---|---|---|
| Name | string | Name of the custom registration field that will be displayed to users. If specified, replaces existing registration field name. | Yes |
| FieldType | string | The type of field. Text or picklist. | Yes |
| Required | boolean | true / false. Specifies whether the registrant is required to complete the field when registering for the event. Default is false. | |
| Options[] | string | Registration field values when FieldType is picklist. | Required if FieldType = picklist. |
| IncludeInAllWebcasts | boolean | true / false. Specifies if the field is included in each public Webcast that is created. Default is false. |
Example Request
{
"Name": "string",
"FieldType": "string",
"Required": true,
"Options": [
"string"
],
"IncludeInAllWebcasts": true
}
Response Codes
| Code | Description |
|---|---|
| 401 | Unauthorized error |
| 500 | Internal server error |
Edit Public Webcast Registration Fields
This API modifies the public Webcast registration fields created for an account.
PUT
/api/v2/accounts/webcast-registration-fields
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| webcastRegistrationField | body | multipart/form-data | Yes |
“Registration Fields” Model Schema
| Name | Type | Description | Required |
|---|---|---|---|
| Name | string | Name of the custom registration field that will be displayed to users. If specified, replaces existing registration field name. | Yes |
| FieldType | string | The type of field. Text or picklist. | Yes |
| Required | boolean | true / false. Specifies whether the registrant is required to complete the field when registering for the event. Default is false. | |
| Options[] | string | Registration field values when FieldType is picklist. | Required if FieldType = picklist. |
| IncludeInAllWebcasts | boolean | true / false. Specifies if the field is included in each public Webcast that is created. Default is false. |
Example Request
{
"Name": "string",
"FieldType": "string",
"Required": true,
"Options": [
"string"
],
"IncludeInAllWebcasts": true
}
Response Codes
| Code | Description |
|---|---|
| 401 | Unauthorized error |
| 500 | Internal server error |
Get Public Webcast Registration Fields
This API retrieves a list of all defined public webcast registration fields for an account.
GET
/api/v2/accounts/webcast-registration-fields
Example Response
[
{
"Id": "string",
"Name": "string",
"FieldType": "string",
"Required": true,
"Options": [
"string"
],
"IncludeInAllWebcasts": true
}
]
Response Codes
| Code | Description |
|---|---|
| 401 | Unauthorized error |
| 500 | Internal server error |
Delete a Public Webcast Registration Field
This API provides the ability to delete a registration field. You must supply the field ID.
DELETE
/api/v2/accounts/webcast-registration-fields
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| fieldId | string | ID of the webcast registration field to delete. | Yes |
Response Codes
| Code | Description |
|---|---|
| 200 | ok |
| 401 | Unauthorized error |
| 500 | Internal server error |
- Add Fields
-
Add Public Webcast Registration Fields
Provides Event Hosts a means to capture attendee details beyond name and email address when hosting Public webcasts. For each custom field created using this endpoint, use the Ids returned in the Create/Edit Webcast APIs (RegistrationFields parameter) to include them in your Webcasts.
POST/api/v2/accounts/webcast-registration-fieldsRequest Parameters
Name Type Description Required webcastRegistrationField body multipart/form-data Yes “Registration Fields” Model Schema
Name Type Description Required Name string Name of the custom registration field that will be displayed to users. If specified, replaces existing registration field name. Yes FieldType string The type of field. Text or picklist. Yes Required boolean true / false. Specifies whether the registrant is required to complete the field when registering for the event. Default is false. Options[] string Registration field values when FieldType is picklist. Required if FieldType = picklist. IncludeInAllWebcasts boolean true / false. Specifies if the field is included in each public Webcast that is created. Default is false. Example Request
{ "Name": "string", "FieldType": "string", "Required": true, "Options": [ "string" ], "IncludeInAllWebcasts": true }Response Codes
Code Description 401 Unauthorized error 500 Internal server error - Edit Fields
-
Edit Public Webcast Registration Fields
This API modifies the public Webcast registration fields created for an account.
PUT/api/v2/accounts/webcast-registration-fieldsRequest Parameters
Name Type Description Required webcastRegistrationField body multipart/form-data Yes “Registration Fields” Model Schema
Name Type Description Required Name string Name of the custom registration field that will be displayed to users. If specified, replaces existing registration field name. Yes FieldType string The type of field. Text or picklist. Yes Required boolean true / false. Specifies whether the registrant is required to complete the field when registering for the event. Default is false. Options[] string Registration field values when FieldType is picklist. Required if FieldType = picklist. IncludeInAllWebcasts boolean true / false. Specifies if the field is included in each public Webcast that is created. Default is false. Example Request
{ "Name": "string", "FieldType": "string", "Required": true, "Options": [ "string" ], "IncludeInAllWebcasts": true }Response Codes
Code Description 401 Unauthorized error 500 Internal server error - Get FIelds
-
Get Public Webcast Registration Fields
This API retrieves a list of all defined public webcast registration fields for an account.
GET/api/v2/accounts/webcast-registration-fieldsExample Response
[ { "Id": "string", "Name": "string", "FieldType": "string", "Required": true, "Options": [ "string" ], "IncludeInAllWebcasts": true } ]Response Codes
Code Description 401 Unauthorized error 500 Internal server error - Delete a Field
-
Delete a Public Webcast Registration Field
This API provides the ability to delete a registration field. You must supply the field ID.
DELETE/api/v2/accounts/webcast-registration-fieldsRequest Parameters
Name Type Description Required fieldId string ID of the webcast registration field to delete. Yes Response Codes
Code Description 200 ok 401 Unauthorized error 500 Internal server error