REST Registration

Update Registrant (event-level)

Updates an event registrant for the given client using the PATCH method. This means that only those registration fields that are part of the request will be updated.

The registrant to be updated will be identified by the provided email parameter value.

Soft Delete

Soft delete is not supported through this endpoint. If you need to perform a soft delete on a registrant, please refer to REST Registration.

Validation

  • An optional '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:

    1. Fields configured as required will be optional (including email)
    2. If a drop-down field is passed, the value must adhere to configured options
  • If any of the fields have been marked as required on the Registration Page Setup, then those fields will be required in the API as well.

  • Drop-down choices will be validated (if the value passed does not exist in the drop-down, an error will be returned.)

  • If a required field is missing or passed in without a value, then an error message will be returned.

patch/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 updated.

Changes

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