Skip Navigation Links

User Attribute Definitions

List user attribute definitions

Requires authentication via bearer.

Allows admin users to retrieve all user attribute definitions.

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

Create new user attribute definition

Requires authentication via bearer.

Allows admin users to create a new user attribute definition.

Request Body

title object[]
technical_name stringrequired

The technical name of the attribute. This is the attribute name that will be accepted and returned by API calls. Required to be unique. Must only contain alphanumeric characters and the characters -, _, .

user_permission stringrequired

The access level of the attribute. This determines if the attribute is visible to end users and whether they can edit it for themselves. "HIDDEN" attributes are only returned in User Admin APIs and User Self APIs, i.e. they can only be accessed by admins and the user themselves.

attribute_type string

The type of the attribute. The type is purely informational, no validations or special formats are enforced.

Response Body

201 Created

Error Codes

  • DUPLICATE_TECHNICAL_NAME
  • LANGUAGE_NOT_ENABLED
  • USER_CREATION_WITH_PENDING_DELETION_NOT_ALLOWED

Get user attribute definition

Requires authentication via bearer.

Allows admin users to retrieve a specific user attribute definition.

Path Params

definition_id stringrequired

Response Body

200 OK

Update user attribute definition

Requires authentication via bearer.

Allows admin users to update a specific user attribute definition.

Path Params

definition_id stringrequired

Request Body

title object[]
user_permission string

The access level of the attribute. This determines if the attribute is visible to end users and whether they can edit it for themselves. "HIDDEN" attributes are only returned in User Admin APIs and User Self APIs, i.e. they can only be accessed by admins and the user themselves.

use_custom_translation boolean

Can only be set on attributes that are predefined. If true, uses the user-provided translations for the attribute title. If false, uses the default Flip translations and clears any custom ones that might have been stored previously.

Response Body

200 OK

Error Codes

  • LANGUAGE_NOT_ENABLED

Delete user attribute definition

Requires authentication via bearer.

Allows admin users to delete a specific user attribute definition.

Path Params

definition_id stringrequired

Response Body

204 No Content

Error Codes

  • USER_ATTRIBUTE_IN_USE_BY_RULES