REST Registration

Update Registrant (client-level)

Updates all registrants for the given client using the PATCH method. This means that only those registration fields that are part of the request will be updated. Because the registration pages for the various events may have different required registration field or allowed values, there will be no validation of the formData values for this request.

If provided, the email parameter in the body of the request (formData) will replace the existing email address for all matching registrants found by the email parameter in the path of the request. Because the registrant's email address must be unique on a per-event basis, if the new email address matches any other registrants for that event, the update will be blocked, and an error message will be returned.

patch/client/{clientId}/registrant/{email}

Request

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

Path parameters

clientIdstring required

The client id is used for authentication

emailstring required

The registrants will be updated that match this parameter

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.