Update a user attribute definition
Organization Admin permissions are required to use this endpoint.
Update a custom user attribute definition. Omitted fields keep their current values. The attribute’s type cannot change, and a multiple-values attribute cannot be changed back to a single value.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
User attribute ID
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Body
Default value applied when no user-specific value is set. A single value when multiple_values is false, an array when it is true.
Strings are trimmed. Number attributes accept numbers or numeric strings and store them as strings. Numbers are converted to strings on receipt; send anything beyond the JSON safe integer range (2^53 - 1) as a string or it loses precision before Omni sees it. Null or a string that trims to empty means no default.
An empty array clears the default of a multi-valued attribute and is rejected for a single-valued attribute. A list member that trims to empty is rejected.
"us-east"
Human-readable description of the attribute and its purpose. An empty string is stored as null.
"User region for row-level security filtering"
Display name shown in the Omni UI. Unique among the custom attributes in the organization, and may match the label of a system attribute.
Must not start with Omni and must not be one of the reserved connection labels: Host, Password, Database, Port, Schema, Connection Name.
1"Region"
Whether the attribute accepts an array of values.
false
Reference name used in model SQL and in embed SSO URL parameters. Unique within the organization. Must start with a letter, contain only letters, numbers and underscores, and must not start with omni_.
1"region"
Response
User attribute definition updated
Default value applied when no user-specific value is set. When multiple_values is true, this is an array. Null if no default is configured.
"us-east"
Human-readable description of the attribute and its purpose
"User region for row-level security filtering"
Unique identifier for custom attributes. Empty string for system-defined attributes.
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Display name shown in the Omni UI
"Region"
Whether the attribute accepts an array of values. When true, default_value and user-specific values are arrays.
false
Reference name used in model SQL and in embed SSO URL parameters
"region"
System-defined attributes (e.g. omni_user_id, omni_user_email) are built-in and read-only. Custom attributes will have a false value.
false
Data type that determines valid values. String attributes accept text, Number attributes accept numeric values stored as strings for precision.
String, Number "String"

