User Attributes

User Attributes gives admins full control over user data by allowing you to create and manage custom fields beyond standard profile information. You can create a range of field types – including free text, checkboxes, and email – and set granular visibility and editing permissions for each. Custom fields can also be added as steps in the onboarding flow, either as mandatory or skippable.

Default Fields

The Default fields tab lists every built-in field on the user profile. Each field has two independent toggles:

• Show in creation flow: Controls whether the field appears on the Create new user form in Manage > Users.

• Required: Enforces the field whenever a user is created or updated – not just through the manual Create new user flow, but also by API-based provisioning and SCIM.

  Note:

  For details on how Required fields behave during creation and editing, see How Required Fields Behave.

Configuring a Default Field

1. On the Thrive menu, go to Configure > User Attributes.

2. On the Default fields tab, find the field you want to configure.

3. Toggle Show in creation flow and Required as needed.

Changes take effect immediately across all creation surfaces – no republish is needed.

1. On the Thrive menu, go to Configure > User Attributes and click the Custom fields tab.
   

2. Click + Create custom field.
   

3. Choose if you want to manually create individual custom fields or bulk upload multiple custom fields using a CSV file.

4. Select your custom field type and click Next:
   

   • Free text: Users can enter any response using regular text, such as a country or job role.

   • Checkbox: Users can select a specific choice, such as agreeing to terms.

   • Email: Users can enter and optionally verify secondary email addresses.

5. On the Configure […] custom field screen:

   1. Enter a Name and Ref for your field, and an optional Description to guide learners.

   2. Set any options specific to your field type:

      • Free text: You can optionally enter a default value that appears automatically for this field.

      • Checkbox: You can optionally Add link to checkbox by entering Link text and a Link URL (e.g., for a privacy policy).

      • Email: You can optionally enable Verify, so users must confirm the email belongs to them, and Unique, so the email address can only be used once across the organisation for this field.

   3. Enable the following display and permission toggles as necessary:

      • Show this field on the user’s profile: Controls if the field is visible to the user.

      • Allow user to update their answer: Determines if the user can edit this detail themselves.

      • Include custom field in exports: Controls if this data is included in admin reports.

   4. Click Next.

6. If necessary, use the Translate custom field values screen to select a Language and provide translated text for the field name and description.

7. Click Save custom field.

The new field will now appear in your User Attributes table, where you can see its Field Type, visibility, and Source (Manual or CSV file). To manage existing fields, click ⋮ Actions to Edit or Delete.

Note:

You can use your custom attributes to capture data from users during their first login by adding them to onboarding steps. For more information, see Onboarding.

Bulk Uploading Custom Fields

1. On the Thrive menu, go to Configure > User Attributes.

2. Click + Create custom field.

3. Select Bulk create Custom Fields via CSV file, then click Next.

4. On the Bulk upload custom field values screen, upload your CSV. The maximum file size is 50 MB.

   Thrive checks the file automatically – confirming it has the required fields, no missing data, the correct data format, and no duplicates.

5. When the checks pass, click Next: Review custom fields.

6. On the Review custom field values screen:

   1. Enter a Custom field group display name.

   2. For each field in the table, set the Include in export, Show on profile, and User can edit toggles as needed.

   3. Click Next.

7. (Optional) On the Translate custom field values screen, select a Language and translate the group and field names.

8. Click Save custom fields.

The published group appears as a single expandable row in your User Attributes table. Click the arrow to view the linked fields within it. Once published, you can add the fields to custom onboarding steps or show them on user profiles as needed.

How Required Fields Behave

Marking a field as Required affects creation and editing differently, and behaves differently depending on the surface used.

• Creating a user: Required fields must be populated on every surface – UI, API, and SCIM – with one exception. Self-registration flows are fully controlled by the admin, who decides which fields are shown and required during sign-up.

• Editing an existing user via the UI: Saving any change requires all required fields to be populated first. If a required field is still empty on an existing user, a UI edit will force it to be filled in.

• Editing an existing user via API, SCIM, or other provisioning: These edits can go through without populating a required field, as long as it's currently empty. This is only possible for users created before the field became required.

• Once populated, always populated: Whether a required field's value was added through the UI or an external service, no surface can clear it back to empty.

CSV File Requirements

Before you upload, make sure your CSV meets the requirements below. Thrive checks the file automatically and rejects anything that doesn't match.