v1

latestSwagger 2.02026-07-14385167.8 KB
Registrants

Create registrant

Register an attendee for a scheduled webinar. The response contains the registrantKey and join URL for the registrant. An email will be sent to the registrant unless the organizer turns off the confirmation email setting from the GoToWebinar website. Please note that you must provide all required fields including custom fields defined during the webinar creation. Use the API call 'Get registration fields' to get a list of all fields, if they are required, and their possible values. At this time there are two versions of the 'Create Registrant' call. The first version only accepts firstName, lastName, and email and ignores all other fields. If you have custom fields or want to capture additional information this version won't work for you. The second version allows you to pass all required and optional fields, including custom fields defined when creating the webinar. To use the second version you must pass the header value 'Accept: application/vnd.citrix.g2wapi-v1.1+json' instead of 'Accept: application/json'. Leaving this header out results in the first version of the API call.

post/organizers/{organizerKey}/webinars/{webinarKey}/registrants

Path parameters

organizerKeyinteger required

The key of the organizer

webinarKeyinteger required

The key of the webinar

Query parameters

resendConfirmationboolean

Indicates whether the confirmation email should be resent when a registrant is re-registered. The default value is false.

Headers

Authorizationstring required

Access token

Acceptstring

Set to 'application/vnd.citrix.g2wapi-v1.1+json' to make a registration using fields (custom or default) additional to the basic ones.

Request body

addressstring

The registrant's address

citystring

The registrant's city

countrystring

The registrant's country

emailstring required

The registrant's email address

firstNamestring required

The registrant's first name

industrystring

The type of industry the registrant's organization belongs to

jobTitlestring

The registrant's job title

lastNamestring required

The registrant's last name

numberOfEmployeesstring

The size in employees of the registrant's organization

organizationstring

The registrant's organization

phonestring

The registrant's phone

purchasingRolestring

The registrant's role in purchasing the product

purchasingTimeFramestring

The time frame within which the product will be purchased

questionsAndCommentsstring

Any questions or comments the registrant made at the time of registration

sourcestring

The source that led to the registration. This can be any string like 'Newsletter 123' or 'Marketing campaign ABC'

statestring

The registrant's state (US only)

zipCodestring

The registrant's zip (post) code

Response

Created

joinUrlstring required

The URL the registrant will use to join the webinar.

registrantKeyinteger required

The registrant's key