Update a custom user field

Use this endpoint to update a custom user field and it's values

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
number
required

User field ID

Body Params
label
object
required
string
enum
required
fileValidation
object

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

number

Sort order within the field category

number

Move the field to a different category

boolean

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

boolean

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

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. Pass an empty array to clear.

staticOptions
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json