Unify Logo Footer.svg
Platform Tools
Logo
Field properties

Field properties

Logo

7 mins READ

The settings you configure on a field besides its type — name, required, unique, default, and more.

Overview

Every field has, beyond its type, a set of properties:

  • Key — the field's internal name, used in formulas, APIs, and queries.

  • Display Label — the friendly name shown in the UI.

  • Help Text — guidance shown to people filling the field.

  • Default value — the value a new record starts with if none is given.

  • Primary Key / Unique Key — uniqueness controls (below).

  • whether the field is optional or required.

  • Display NameSecureHashing, and the searchable / sortable / filterable toggles (each covered below).

  • Nest under — place the field inside an existing Object field instead of at the top level.

  • Control Visibility — show or hide the field in forms based on conditions on other fields.

The Key is fixed as soon as the field is created; the type is fixed once the object holds records; most other properties can be changed later.

Where: Object › Schema › add or edit a field

Field-prop-1 1.png
Field-prop-1 1.png

Rules for a field's Key (internal name)

The Key is the field's machine name — what automations, formulas, and the API use to read and write it. It must start with a letter and contain only letters, numbers, and underscores (no spaces or punctuation). It's separate from the Display Label, which is the human-friendly name you see in tables and forms — that one can be anything and can be changed anytime. Once a field is created the Key is read-only, because changing it would break everything referencing it, so choose a clear, stable Key up front and rename the Display Label freely instead.

Where: Object › Schema, field Key vs Display Label

Making a field required or optional

A field is either required or optional. Mark it optional to allow records to be saved without a value; leave it required to force a value on every record. Required fields are enforced when a record is created or edited — a missing value blocks saving and is flagged inline. Two fields can't be optional: the Primary Key and the object's Display Name field, since those must always have a value. Set fields you genuinely need (a name, a status) as required, and make the rest optional so records aren't harder to create than necessary.

Where: Object › Schema, field optional/required

Primary Key

The Primary Key is the field that uniquely identifies each record in the object. Marking a field as Primary Key makes it required — a record can't be saved without a value for it — and its value actually becomes the record's built-in ID, so your business identifier (an order number, an email) is what relationships and the API use to point at the record. Only certain types can be a primary key — String, Number, Integer, or Auto Number — because the value has to be a stable identifier; choosing any other type shows Invalid Field Type for Primary Key, and a nested field (inside an Object or Array) can't be one. Without a Primary Key, records get an automatically generated ID instead.

Where: Object › Schema, Primary Key

Display Name field

One String field can be marked as the object's Display Name — the field whose value stands in for the record wherever the record is referenced. When another object links to this one (through a lookup), or a record is shown in a picker, it's the Display Name value that appears, instead of the raw ID. Only String fields can serve as the Display Name, it can't be optional, and it's automatically made searchable — it's also the field the records screen's search box matches against. Pick the field that best labels a record to a human (a person's name, a company name, a title) so references read clearly everywhere.

Where: Object › Schema, Display Name

Protecting sensitive field data (Secure and Hashing)

Two options protect sensitive values:

  • Secure Field stores the value encrypted at rest, so it's protected in storage but can still be read back when needed.

  • Enable Hashing stores a one-way, salted hash of the value — it can be checked against but never read back in its original form (suitable for things you only need to compare, like a secret).

A field can use one or the other, not both — turning one on disables the other. Use Secure for data you must store and later retrieve safely (tokens, account numbers); use Hashing for values you only ever need to verify, never display.

Where: Object › Schema, Secure / Hashing

FAQs

What's the difference between a Primary Key and a Unique Key?

Both enforce uniqueness, but differently. A Primary Key is the identifier for the record — one per object, always required, and its value becomes the record's ID. A Unique Key simply ensures uniqueness of values across records for that field without making it the record's identifier — it's backed by a unique index in the store — and you can mark more than one field unique. Unique Key follows the same type rules as Primary Key (String, Number, Integer, or Auto Number; no nested fields) and is only available on JSON Store objects. Use Primary Key for the record's main identifier; use Unique Key for other fields that must not repeat (for example an email or SKU that should be unique but isn't the primary identifier).

Where: Object › Schema, Unique Key

What do searchable, sortable, and filterable do?

These toggles control how a field can be used when working with records:

  • Searchable — the field's text is included when you search records.

  • Sortable — you can sort the records table by this field.

  • Filterable — you can add filters on this field in the records table.

All three are off by default. Enabling them makes the field more useful in the records view but can add overhead, so turn them on for fields people actually search, sort, or filter by (status, name, dates) and leave them off for fields that are only ever read on a single record.

Where: Object › Schema, advanced field settings

Can I set a default value for a field?

Yes — set a Default value so new records start with that value when none is provided. The kind of default matches the field type (a number for Number, true/false for Boolean, a date for Date, an option for a dropdown, and so on). The default is filled in by the create form, saving people from re-entering the same common value — so if you create records another way (from an automation or an import) and don't supply the field, the default isn't applied for you; set the value explicitly there. Editing the default later affects new records you create, not ones already saved.

Where: Object › Schema, Default value