Skip to main content

Common Field Mappings

Curious where some common data can be found in the API? This page will attempt to point you in the right direction.

Activation/campaign information

Some vendors use the term "campaigns", but at Wit, we refer to these as "activations".

  • Activation types, titles, descriptions, start/end times, and sponsor info are available for all activations, and can be collected from any of the API calls.

Basic user data (name, email, phone, address, etc)

  • First name, last name, and email address are collected for all activations, and are always available in the Entry objects in each activation.
  • Phone numbers, date of birth, and other such information can be added as Extra options to each activation when necessary.
  • Mailing addresses are typically not collected, except for giveaways where the entrant has won a prize that is to be mailed. These would be found in the Address object for an entry.

Question data (checkboxes, dropdowns, extra text fields, etc)

  • Every activation has an extras array, featuring Extra objects, that contains arbitrary questions added to a particular activation.

Email opt-in flags

Each activation has a boolean emailOptIn field that, by default, determines if the user has opted-in to receive emails from both your organization and from the attached sponsor, if any.

If your sponsor has specific legal requirements and desires a separate opt-in, this would typically be added as a checkbox in the Extra options.