list_user_attributes last
in the display order.
This writes to every existing user. The attribute is opened on each one
of them at creation — empty, except a bool, which starts at false for
everyone — and an amount attribute also records the company currency there.
So creating an attribute touches the whole user table, not just the
definition. Load the values by Excel import from the Qobra web app, which is
also where a default value is set.
Creating the people is not done here: they come in by Excel import from the
Qobra web app, which is also where an attribute synced from an HRIS or a CRM
is set up.
Available only where the Qobra write tools beta is enabled. Every write is
recorded in the audit trail as the Qobra MCP agent.
Parameters
Body
Body
string
required
Display name of the attribute, as people will read it in Qobra —
‘Segment’, ‘Hiring date’, ‘Region’.
string
required
The attribute’s stable key: the identifier the public API and an Excel
import address it by, distinct from the display name. Lowercase and
underscore-separated, and unique across the company’s attributes
(‘Hiring date’ gives ‘hiring_date’). The public API already serves every
user an
id, email, status, name, role, currency and
calculation_currency, so those seven are taken.string
required
What the attribute holds.
amount is monetary and percentage a ratio,
where 0.15 reads as 15%; float is a plain number, for a count or a
quantity. user holds a Qobra user, matched on their email when people
are imported. picklist is one choice out of a fixed list and
multipicklist several — both need options. One of: float,
amount, percentage, string, picklist, multipicklist, bool,
date, user.string[]
The labels people choose from, for a picklist or a multipicklist
attribute — required there, and refused on every other type. These
exact labels are what a user’s value is matched on when people are
imported.
boolean
Include this attribute in the company’s user exports. Off by default, as
it is in Qobra.
boolean
Refuse two users the same value — for an employee number or a payroll
id, not for a segment everyone shares. Applies to a
string or a
float attribute only.Response
Body
Body
object
The attribute as it now exists — the same row list_user_attributes
returns, so the id can be reused straight away.