REST Registration

REST Registration API

Creates a registrant.

Soft Delete

Perform a soft delete operation on a particular Registrant by sending the 'isDeleted' form parameter with the value of (Y or N) to update the deleted state of such Registrant. This value can be sent along with the other form parameters listed in the table above. Deleting/Undeleting a registrant is not allowed after the event has started.

NameLocated InRequiredDescriptionDefaultSchemaExample
isDeletedformDatayesPerforms an update on the isDeleted property of a Registrant-stringY
emailformDatayesThe email of the registrant who will be updated-stringjohn.doe@domain.com

Validation

  • If a field is configured as "required" on the registration page, you must pass in a valid value, or the request will not be successful unless you are using the honorrequired as "N" parameter.
  • The honorrequired parameter is supported with possible values of Y or N. If Y is passed (or no value or no parameter is passed), the endpoint will behave as it currently does. If N is passed:
    • Fields configured as required will be optional (including email)
    • If a drop-down field is passed, the value must adhere to configured options unless you are using the honorvalidation as "N".
post/client/{clientId}/event/{eventId}/registrant

Request

  • Base URL: https://api.on24.com/wcc/api/v2
  • URL: https://api.on24.com/wcc/api/v2/client/{clientId}/event/{eventId}/registrant
  • Auth: one of:
    • API key in header AccessTokenKey
    • API key in header AccessTokenSecret

Path parameters

clientIdnumber required

The client id

eventIdnumber required

The event id

Query parameters

honorrequiredstring

Specifies whether the required registration fields must be honored or not.

honorvalidationstring

Specifies whether validation of response options for registration questions must be honored. Using 'N' allows any value to be pushed to fields with specified values for dropdown list, checkboxes, etc.

Headers

accessTokenKeystring required

client access token key

accessTokenSecretstring required

client access token secret

content-typestring required

must be "application/x-www-form-urlencoded"

acceptstring

Output format. possible values: Application/xml or Application/json

Response

Registrant Created.

Changes

No recorded changes to this operation across all 1 revision of this API.