Registration Guide
In this guide, you’ll learn the workflow required to successfully register contacts for your Cvent events using the REST API.
Event Management#
Let’s say you are using a non-Cvent program to collect registrations, and you want to import a list of your registrants into the Cvent platform. This guide will describe all the steps required to successfully register a list of contacts for your Cvent event. First, you must determine: Does an event already exist in Cvent to import my registrants into? If yes, you can retrieve the event’s ID by using List Events. If not, you’ll need a Cvent user to create an event first (see Creating an Event).
Once you have the event’s ID, you’ll also need an admission item ID. Each event registrant requires an admission item to be assigned to them. You can use List Admission Item to find the admission item ID.
API Summary#
Description | Endpoint | Workflow Notes |
---|---|---|
Retrieves a list of events | GET/events | Store the Event ID retrieved. |
Retrieve a list of admission items | GET/admission-items | Filter the results by the Event ID to see the relevant admission items. Store the admission item ID's found. |
Contact Updates#
To register people in your Cvent event, they must first be Cvent contacts. You can run List Contacts to inventory your already existing contacts. You can add or update contacts in your address book via Create Contacts, Patch Contacts or Update Contacts.
After all the contacts have been added, you can use List Contacts to retrieve and store each contact ID for use in the next step.
API Summary#
Description | Endpoint | Workflow Notes |
---|---|---|
Retrieve a list of contacts | GET/contacts | This step is determining what contacts already exist. Run once more after creating/updating contacts to get a final list of contact IDs to use in the registration step. |
Creates new contacts | POST/contacts | Use this to create any new contacts that don't previously exist in the address book. Use Bulk when adding many contacts. |
Update the details of existing contacts | PUT/contacts/{id} | Optional step if the contact exists already and needs to be updated |
Register Attendees for Event#
Once you’ve collected the details of the event and uploaded your list of contacts, you’ll be able to register them for your event by leveraging Add Attendees. You’ll need to supply the event ID of the event you are registering contacts into, the admission item ID of the admission item they should be registered for, along with the contact ID of the individual you are registering. You’ll also need to supply a registration status for the registrant. Use Accepted to register the user for the event.
API Summary#
Description | Endpoint | Workflow Notes |
---|---|---|
Adds attendees to an event | POST/attendees | Supply the event ID, admission item ID and contact ID. Set the registrant's status to Accepted to register them for the event. Use Bulk when adding many registrants to the event. |
(Optional) Register Attendees for Sessions#
Some events use sessions, and occasionally it’s desirable to pre-register users for sessions prior to the event. If sessions already exist you’ll be able to retrieve their details with List Sessions. If they don’t already exist, you can use the Create Session API to create the needed sessions.
API Summary#
Description | Endpoint | Workflow Notes |
---|---|---|
Retrieves a list of sessions. | GET/session | Filter by the event ID to get only the relevant sessions. Store the session IDs received. |
Creates a new session | POST/sessions | Optional step. |
Enrolls registrants into specified session | POST/sessions/{id}/enrollment/{attendeeId} | Supply the attendee ID and session ID to register attendees to the session. Use Bulk when registering attendee(s) for multiple sessions. |