Create a custom attribute

Define a new attribute in Jimo, hand the generated snippet to your engineers, and watch it flip from Pending to Active.

Dashboard path: Users & Segments > Data Management > Attributes > + New Attribute

Why this page exists

Creating an attribute used to be engineering work end to end. A developer hand-wrote the SDK call, and until someone pushed it, the attribute did not exist in Jimo at all.

So a product team wanting a new field to segment on had to file a ticket and wait for a sprint slot, even though the part that needed product judgment, deciding the attribute and its type, took a minute.

Now the two are split. You define the attribute here. Your engineers only implement it.

1

Define it

Field
Display name	The human label. Can be changed later.
Code name	The exact key your app will send. Can NOT be changed later. This one ispermanent.
Description (optional)	What it holds. Shown under the display name everywhere.
Data type	Editable later, but changing it does not convert the values already stored. See Attributes.

The five data types

Type	For	Example
Text	strings	"en", "Pro"
Number	numeric values	42
Datetime	dates	"2024-06-15"
True or false	booleans	true
List	multiple values	["edit", "publish"]

The type decides which operators you get in the segment builder. A Datetime gives you is within the last (days). A Text does not.

The code name is locked from the moment you hit Create, forever.

It is the key your app sends. Changing it would orphan everything already pushed under the old one. The only way out is to delete the attribute and recreate it, which clears the stored data until your app pushes it again.

Take the extra minute now.

The data type is not permanent, but it is not retroactive either. You can change it later: that changes the operators you get in the segment builder, not the values already stored. Picking the right one now still saves you a data refresh later. See Attributes.

2

Install it

The attribute lands in Pending. It holds nothing yet, and it is not usable anywhere.

Install Attributes opens the snippet:

/**
 * Jimo Custom User Attributes
 * Docs: https://help.usejimo.com/docs/analyze/users-and-segments/users/attributes
 * SDK setup guide: https://help.usejimo.com/docs/for-developers/for-developers/sdk-guides/setup-the-segmentation
 */
window.jimo.push(['set', 'user:attributes', [{
  /**
   * Attribute Name: Example_new (Code name: example_new)
   * Type: Text, e.g. "en"
   */
  example_new: "YOUR_VALUE",
}]]);

Add this snippet where you send user data to Jimo so these attribute values are received.

Jimo writes the exact key and a value format matching the type you picked. Your engineers replace YOUR_VALUE with the real value from your systems.

Send to Developer hands it over without a copy-paste round trip, it automatically drafts an email ready to send.

Where to put it. Wherever you already send user data to Jimo. If you have no such place yet, start with Setup the segmentation.

Push your set commands before your identify call: everything is buffered and applied in order once the profile is initialized. See Identify users.

3

Watch it go Active

Once Jimo receives a value for that key, the attribute moves almost instantly to Active on its own. Nothing to click.

From that moment it shows up in the Users filter, the segment builder and the Who step.

It takes generally less than a few second for attributes to actualize in the dashboard.

It stays Pending

Three usual suspects, in order of likelihood:

1. The code name does not match. Character for character, case included.

2. The snippet does not run for real users. It is on a page they never reach, or behind a condition.

3. The users are not identified. No profile, nothing to attach the value to. See Identify users.

Related pages

• Attributes: the full list and what each column means

• Setup the segmentation: the SDK reference

• Imports: create custom attributes from a CSV instead