update users

put

https://<subdomain>.huvrdata.app/api/users/{id}/

User update

Required permissions:

IsAuthenticated
WorkspaceRequired
HasRolePermissions::user_edit

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

name

string | null

username

string

required

length between 1 and 150

^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

string

length ≤ 254

first_name

string

length ≤ 150

last_name

string

length ≤ 150

is_active

boolean

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

roles

array of strings

roles

company_id

integer

send_welcome_email

boolean

Defaults to true

send welcome email to new users

note

string

length ≤ 500

Optional free-text reason for creating the user (e.g. 'Requested by support ticket #1234'). Stored only in the audit log, not on the User row.

labels

object

List of Key/Value pairs where keys are 'name' and 'value'

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

application/yaml

200