Skip to content

Manage Participant Attributes

VeySur has a fixed set of system attributes for every participant: First Name (nameFirst), Last Name (nameLast), Email (email), Language (language), and Token (token). For survey-specific data, custom attributes can be defined: named string fields (up to 256 characters) scoped to a single survey.

For a full field-level reference see Participant Attributes.

SystemCustom
PredefinedYesNo, user-defined
Per-survey scopeNo, shared across all surveysYes
Multilingual labelsNoYes
Editable in admin formsYesYes
Exported in CSVYesYes, appended after system columns
Internal flagNoYes, hides from participant signup
  1. Open your survey and go to the Participants tab.
  2. Click the Manage Attributes button in the toolbar.

The panel shows system attributes (read-only) followed by any custom attributes you have defined.

  1. In the Manage Attributes panel, click Add Attribute.
  2. Enter a valid attribute name (letters, digits, _, $; cannot start with a digit; max 64 characters; cannot shadow a system attribute or JavaScript reserved word).
  3. Optionally check Required if participants must provide this value.
  4. Optionally enter an Example value to guide CSV importers.
  5. Click Save.

Check Internal on an attribute to make it admin-only. Internal attributes:

  • Do not appear in the participant signup form
  • Are included in CSV export columns and accepted during CSV import like any other custom attribute
  • Remain readable and editable from the admin Participants tab

Use this for values you populate via import or API that participants should not see or fill in. Internal attributes remain available when building conditions.

  1. Use the language selector at the top of the panel to switch language.
  2. Click the label or description field of the attribute you want to translate and enter the text.
  3. Save the translation.

When the survey-taking flow shows attribute prompts, it uses the participant’s language, falling back to the survey’s default language, then to the attribute name if no label is configured.

Drag the handle on the left of each custom attribute row, or use the reorder buttons, to reorder. The order determines the column order in CSV exports.

Click the attribute’s name field and edit it. When you leave the field, a confirmation dialog warns you that renaming updates the stored key in every existing participant record and cannot be undone. Confirm to proceed.

This is destructive. The old key is removed from all participant records and replaced with the new key. Any CSV or API integrations that use the old name will need to be updated.

Click the Delete (trash) icon on the attribute row. A confirmation dialog warns you that deletion permanently removes the stored value from every participant in this survey and cannot be undone.

This is destructive. All participant records lose the value for this attribute.

When you publish a survey, VeySur freezes the current attribute definitions (names, Required flags, Internal flags, and language labels) into the publication snapshot. Participants who sign up under that publication always see the frozen set.

Changes you make to attributes after publishing (adding, deleting, renaming, toggling Internal/Required, editing labels) take effect only in new publications; the active publication is unaffected.

Note. If you add a required attribute after publishing, existing participants are not prompted for it. Create a new publication to apply the new attribute set.

See Publications for how snapshots work.

The participant CSV export appends one column per custom attribute (by name) after the standard system columns. The column header is the attribute name, making the file round-trip-safe on re-import.

During import, any column whose header matches a defined custom attribute name is loaded into that attribute on each participant. Values longer than 256 characters are truncated. Existing attribute values on a participant that are not present in the CSV are left unchanged (partial update).

See Invite Participants for full CSV import/export instructions.

Custom attribute definitions are included in VSST and VSSA survey exports, so the attribute schema transfers when you export a survey template and import it elsewhere. VSSP publication exports include definitions via the publication snapshot.

See Import / Export for format details.