Attributes

Creating custom user attributes through the attribute manager

Attributes can be incredibly important when it comes to reporting and automations. Attributes are additional information you can attach to Users, Collections or Exams and they can be anything you want, for example:

  • Region

  • University

  • Date of birth

  • Course

  • Product name

  • Consent to emails

Attributes will be included in exports and shown in tables, see below for an example of how this data is stored on the user

{
  "gdpr_consent": true,
  "country": "USA",
  "role": "busDriver",
  "training-year": 2,
  "date-of-birth": "1989-12-07T00:00:00.000Z",
  "segment-trait": "Performance Review"
}

๐ŸŽจ Attribute manager

In order to create an attribute go to Settings > User attributes. Use the attribute manager to view existing attributes or create a new one

Add attribute to make a new attribute.

  • Label * = Name of the attribute and how it will appear on tables

  • Description = Displays as a hotspot on tables for other admins / educators. For attributes collected on registration the description will display here also.

  • ID = Inferred from the Label, spaces will be replaced with - these IDs are important and required on all imports using attributes, you'll also need them to match up attributes in Zapier and Segment.

  • Who can edit = Select which users have write access to this attribute (you may not want students to be able to update certain attributes ie Year group)

  • Settings: - Hidden from user = These attributes will never be shown to users, they are for admins and educators only - Collect on registration = These attributes will be collected on registration when a user is setting up their account. If this option is selected you'll be prompted to select a question to ask students on the registration page. You can also make an attribute required here which means a user can't be registered without a value for this attribute. Please note this applies both to users registering themselves and admins generating accounts.

  • Type* = Select the type from the dropdown, different types require different values, some may need you to define some options. See below for more.

Once you've finished creating attributes, save your changes. Once you have added attributes, the user importer template you can download from the Import users subpage of a user group will include columns for your custom attributes. This allows you to enter attributes for users when importing in bulk.

๐Ÿšจ Be careful deleting attributes! We don't limit the number you're allowed. However deleting attributes could cause problems if they're being used in other integrations.

Last updated