Sign in
User Properties

Add User Property

Adding a user property is somewhat equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.

put/{databaseId}/users/properties/{propertyName}

Path parameters

databaseIdstring required

ID of your database.

propertyNamestring required

Name of the user property to be created. Currently, the following names are reserved: id, userid, case-insensitively. Also, the length of the property name must not exceed 63 characters.

Query parameters

type'int' | 'double' | 'string' | 'boolean' | 'timestamp' | 'set' required

Value type of the user property to be created. One of: int, double, string, boolean, timestamp, set.

  • int - Signed integer number.

  • double - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).

  • string - UTF-8 string.

  • boolean - true / false

  • timestamp - Value representing date and time.

  • set - Set of strings.

Response

Successful operation.

Changes

No recorded changes to this endpoint across all 1 revision of this API.