Skip to main content
PUT
/
platform
/
admin
/
users
/
user
cURL
curl --request PUT \
  --url https://api.example.com/platform/admin/users/user \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "firstName": "Jane",
  "lastName": "Smith",
  "id": 5,
  "isEnabled": true,
  "userId": 1
}
'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Query Parameters

​
api-version
string | null

Body

application/json

Platform user update request body.

​
email
string

Email address for the new platform user account.

Example:

"[email protected]"

​
firstName
string

First name of the platform user.

Example:

"Jane"

​
lastName
string

Last name of the platform user.

Example:

"Doe"

​
id
integer<int64>

Unique identifier of the platform user to update.

Example:

5

​
isEnabled
boolean

True if the platform user account is active and can access the system.

Example:

true

​
userId
integer<int64>

Internal domain user identifier for audit and tracking purposes.

Example:

1

Response

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{
  "email": "[email protected]",
  "firstName": "Jane",
  "lastName": "Doe",
  "id": 5,
  "isEnabled": true,
  "userId": 1
}