Skip to main content
PATCH
/
v1
/
console
/
users
/
{user_id}
Update User
curl --request PATCH \
  --url http://localhost:8000/v1/console/users/{user_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "department": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "middle_name": "<string>",
  "programme_codes": [
    "<string>"
  ],
  "role_id": "<string>",
  "title": "<string>",
  "unlimited_sessions": true
}
'
{
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "id": "<string>",
    "last_name": "<string>",
    "unlimited_sessions": true,
    "department": "<string>",
    "last_activity_at": "2023-11-07T05:31:56Z",
    "middle_name": "<string>",
    "programme_codes": [],
    "role_id": "<string>",
    "role_name": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "message": "<string>",
  "success": true
}

Authorizations

Authorization
string
header
required

Enter your JWT access token

Path Parameters

user_id
string
required

Body

application/json
department
string | null
Maximum string length: 255
first_name
string | null
Required string length: 1 - 255
last_name
string | null
Required string length: 1 - 255
middle_name
string | null
Maximum string length: 255
programme_codes
string[] | null
role_id
string | null
status
enum<string> | null
Available options:
active,
inactive,
deleted
title
string | null
Maximum string length: 100
unlimited_sessions
boolean | null

Response

Successful Response

data
UserResponse · object
message
string | null
success
boolean
default:true