Create a custom user field

post

https://api.premote.io/v1/user-fields

Use this endpoint to create a custom user field

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

User field definition. Also accepts an optional customObjectTypeId (number) to attach the field to a custom object type.

label

object

required

type

string

enum

required

key

string

required

unique slugified key of the field

fieldCategoryId

number

required

ID of the field category the field should be in

fileValidation

object

File validation config: { preset, allowedExtensions, maxFileSizeBytes, minFileSizeBytes }

order

number

Sort order within the field category

showMetadata

boolean

For FILE / FILES fields: ask the uploader to fill in file metadata (e.g. validity dates).

hidden

boolean

When true, the field stays configured but is not shown to end users on their profile form.

isPrivate

boolean

Private fields are only readable by the field owner (the employee) and super-admins.

staticOptions

array of objects

For REFERENCE* and SELECT field types: a static list of options. Persisted as a generated referenceSQL string so the read path stays unchanged.

staticOptions

Response

201The created user field.