Skip to main content
PUT
Update one User

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

type
enum<string>
required

Specify the user type to which your operations will be restricted.

Available options:
any,
organization,
client
id
integer<int32>
required

The id of the referenced User.

Required range: x >= 1

Body

application/json

An object conforming to the User schema to be merged with the existing User.

A user with organization-wide access.

type
enum<string>
required

This property describes the type of object in the response body.

Available options:
OrganizationUser
name
string

The full name of the user.

Maximum string length: 65
Example:

"Bernard Greensmith"

email
string<email>

The user's email address.

Maximum string length: 128
Example:

"admin@example.com"

username
string

User name for login.

Maximum string length: 40
Example:

"b.greensmith"

is_active
boolean

Only active users may log in.

Example:

true

roles
UserRoleRef · object[]

A list of user roles allowed for this user.
Optional Field

login_via_badge
boolean

This flag must be true to allow login with badge capability.
Optional Field

Example:

true

default_warehouse
WarehouseRef · object | null

The last Warehouse that was active for the user.
Optional Field

Response

OK - The operation completed successfully and there is no response body.