OMomni
User attributes

Update a user attribute definition

Changed on
<Note> **Organization Admin** permissions are required to use this endpoint. </Note>

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.

put/v1/user-attributes/{userAttributeId}

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/user-attributes/{userAttributeId}
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

userAttributeIdstring uuid required
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

User attribute ID

Request body

descriptionstring

Human-readable description of the attribute and its purpose. An empty string is stored as null.

idstring

Unique identifier for custom attributes. Empty string for system-defined attributes.

labelstring

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.

multiple_valuesboolean

Whether the attribute accepts an array of values.

namestring

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_.

systemboolean

System-defined attributes (e.g. omni_user_id, omni_user_email) are built-in and read-only. Custom attributes have a false value.

type'String' | 'Number'

Data type that determines valid values. String attributes accept text, Number attributes accept numeric values stored as strings for precision. Immutable after creation.

Example request

{
  "description": "User region for row-level security filtering",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "label": "Region",
  "name": "region",
  "type": "String"
}

Response

User attribute definition updated

descriptionstring required

Human-readable description of the attribute and its purpose. An empty string is stored as null.

idstring required

Unique identifier for custom attributes. Empty string for system-defined attributes.

labelstring required

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.

multiple_valuesboolean required

Whether the attribute accepts an array of values.

namestring required

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_.

systemboolean required

System-defined attributes (e.g. omni_user_id, omni_user_email) are built-in and read-only. Custom attributes have a false value.

type'String' | 'Number' required

Data type that determines valid values. String attributes accept text, Number attributes accept numeric values stored as strings for precision. Immutable after creation.

Example response

{
  "description": "User region for row-level security filtering",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "label": "Region",
  "name": "region",
  "type": "String"
}

Changes