REST API - Saving Contacts

In the context of EventLyte, a Visitor, Exhibitor, or any other person is considered a contact. The endpoint for contacts is:

https://your-instance.crm.eventlyte.com/api/records/contacts

Record Keys

There are 2 ways to correlate and update existing records within EventLyte.

1. Card Number (cardNumber) - A readonly field built into EventLyte CRM and is auto-generated for optional use within printing

2. Correlation ID (correlationId) - An identifier that you own that is immutable within your system

If either of these are supplied, in most cases, the correlationId will be by integrators, then the record will be merged together.

Barcodes

EventLyte CRM, when scanning onsite or looking up at kiosks, will look at the barcode table for a person in order to resolve them. If you have a historical set of barcodes for contacts, you can use the barcodes array in the request body.

If barcodes are pushed into EventLyte CRM during an event, and the contact has had a badge reprinted with the Unique ID system enabled, the barcodes will be set to Inactive. If the same barcodes are sent in again they are simply ignored.

For records that are not printed, access control scanning will continue to operate as normal.

Example Payloads

Refer to the Swagger URL related to your EventLyte CRM instance for exact fields available:

REST API - Overview | Swagger

1. Create a new record with 3 barcodes

   JSON

   {
     "data": {
       "correlationId": "25850b37-5afc-497a-adf4-858d7d1c30f1",
       "firstName": "Sally",
       "lastName": "Jones",
       "companyName": "HP"
     },
     "barcodes": [
       "barcode1",
       "barcode2",
       "barcode3"
     ]
   }

2. Update a record with the same correlation identifier, with 5 barcodes

   JSON

   {
     "data": {
       "correlationId": "25850b37-5afc-497a-adf4-858d7d1c30f1",
       "firstName": "Sally",
       "lastName": "Jones",
       "companyName": "IBM"
     },
     "barcodes": [
       "barcode1",
       "barcode2",
       "barcode3",
       "barcode4",
       "barcode5"
     ]
   }

3. Update a record allowing null values in the URL with ?allowNullValues=true

   JSON

   {
     "data": {
       "correlationId": "25850b37-5afc-497a-adf4-858d7d1c30f1",
       "firstName": "Sally",
       "lastName": "Jones",
       "companyName": null
     }
   }

4. Add a photo to an existing record

   JSON

   {
     "data": {
       "correlationId": "25850b37-5afc-497a-adf4-858d7d1c30f1",
       "photo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAAXNSR0IArs4c6QAAAHRJREFUGFcBaQCW/wFRH4b/0t6ZAATPiACsDRIA0O4bAAGU8Sr/SfJXAD+PBgCH64wAwEd+AAHnhXr/FB/6ABWUpQAqlRgAMx9SAAEbg7r/p+QZAGZ33QDmUEcArR/9AAFjtA3/QjgJABNcHgDQwxYAs5KeAH1EJ292KQF7AAAAAElFTkSuQmCC"
     }
   }