Skip to main content
PATCH
/
users
/
{id}
Update a user
curl --request PATCH \
  --url https://api.platform.dakota.xyz/users/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "first_name": "John",
  "last_name": "Doe",
  "role": "admin"
}
'
{
  "code": "invalid_request",
  "message": "The request was invalid. Please check your input and try again.",
  "details": {
    "field": "amount",
    "issue": "must be greater than 0"
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Unique identifier of the user to update KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

Body

application/json

Updated user details

Request body for updating a client user

​
first_name
string

Given name of the user

Minimum string length: 1
Example:

"John"

​
last_name
string

Surname of the user

Minimum string length: 1
Example:

"Doe"

​
role
enum<string>

Role that can be assigned to a client user

Available options:
admin,
viewer
Example:

"admin"

Response

user updated successfully