Skip to main content
HTTP Method: POST URL: /api/v1/events/{eventId}/registrants Authentication: Requires API Key in the request header. Path Parameters:
  • eventId ID of the event to register the audience to. To find this value, visit the schedule page and click “Copy event ID” in the three dots menu.
Request Body Paramaters:
  • email: Email address of the registrant. Must be unique per event.
  • first_name: Registrant’s first name.
  • last_name: Registrant’s last name.
  • custom_fields: Key-value map of custom registration fields. Keys are custom field IDs, values are the submitted responses.
    Notes:
    • email, first_name & last_name are always mandatory for every webinar.
    • Rest of paramaters are mandaroty only if defined so in the registration form setup when scheduling the event.
    • phonefield: phone number in international format, seperated to country code and phone number.
    • countryfield: Country of the registrant as an alpha-2 country code.
    • text field: limited to 256 charachters.
    • checkbox field: limited to TRUE or FALSE
Response: confirmation for registration, including the event ID and unique join URL. Rate limit: once every 30 seconds for unique request. Status Codes:
  • 200 OK Registration created successfully. 401 Unauthorized Authentication failed (Invalid or missing API token).
  • 404 Not Found Event not found.
  • 409 Conflict Duplicate registration (a registrant with the same email already exists for this event).
  • 422 Unprocessable EntityValidation error (for example, invalid email format, unsupported country code, or invalid custom_fields payload).

​
Sample Request

POST /api/v1/events/123/registrants HTTP/1.1
Host: platform.riverside.fm
Authorization: BEARER YOUR_API_KEY

{
  "email": "person@example.com",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "custom_fields":  [
	{
      "field_id": "qumjf",
      "value": "one"
    },
    {
      "field_id": "4cb7n",
      "value": "United States"
    },
    {
      "field_id": "6jmb8",
      "value": {"countryCode":"+1","phoneNumber":"555555555"}
    },
    {
      "field_id": "0pc5l",
      "value": true
    },
    {
      "field_id": "1ddd5",
      "value": "Answer 1"
    }
  ]
}

​
Sample Response

{
  "email": "person@example.com",
  "event_id": "123",
  "join_url": "https://riverside.fm/join/abc"
}