Skip to content

User Attributes ​

The User Attributes page defines the custom profile fields available across customers. When you add an attribute here, every customer can choose to enable it; their users then see the field on the Account page and the Complete Profile flow.

List page ​

Toolbar ​

  • New Attribute button (top right).
  • Status dropdown — All / Active / Archived. Defaults to Active.
  • Count chip — number of attributes matching the current status.

Columns ​

ColumnNotes
LabelHuman-readable name (e.g. "Employee ID").
KeyMachine slug, lowercase with underscores. Immutable after creation.
TypeText / Number / Select / Multi-Select / Date / Switch.
RequiredYes (green) / No (muted). Default for new customers.
OrderNumeric sort order in forms.
StatusActive / Archived.
ActionsEdit (disabled for archived), Archive (active only, with confirmation).

Creating an attribute ​

Click New Attribute.

FieldNotes
KeyLowercase letters, numbers, underscores. Must match ^[a-z][a-z0-9_]{1,63}$. Cannot be changed later.
LabelRequired.
TypeRequired. Cannot be changed after creation.
OptionsShown for Select and Multi-Select types. Chip editor — add and remove options. At least one option is required.
PlaceholderHint text shown in the form field.
Sort OrderNumber input. Auto-increments based on existing attributes.
Required by defaultToggle. Sets the default for customers who enable the attribute.

Click Create. The attribute appears in the list as active.

Editing an attribute ​

The pencil icon opens the edit modal with the same fields as Create, but Key and Type are read-only. You can change Label, Options (for select types), Placeholder, Sort Order, and the Required-by-default toggle.

Archiving an attribute ​

The trash icon archives the attribute. Archived attributes:

  • Do not appear on user profile forms.
  • Cannot be edited.
  • Are hidden from the default list view.

Archive is the closest thing to delete the page offers — there is no destructive delete, by design. Existing values on user profiles are preserved.

How customers use these attributes ​

Each customer chooses which attributes are active for their users on the User Attributes tab of the customer detail page (operator side) or via the Customer Portal Settings → User Attributes (customer side). They can override the "required" default per customer.

Users see the attributes on:

  • The Complete Profile flow during first sign-in (required ones must be filled).
  • Their Account page → User Attributes section (for ongoing edits).
  • The invite acceptance form (the relevant ones, depending on the customer's configuration).

Notes ​

  • The slug pattern is strict on purpose — keys appear in API payloads and webhooks.
  • "Required by default" only affects the initial setting per customer; customers can relax the requirement on their side.
  • The page never deletes data. Archived attributes can be revisited and listed by switching the Status filter to "Archived".