Skip to main content
PUT
/
api
/
admin
/
userInstitution
/
{userId}
Update user institution attributes such as account type, status, etc.
curl --request PUT \
  --url http://localhost:3000/api/admin/userInstitution/{userId} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "accountType": "admin",
  "entitlements": [
    "institutions.list",
    "institutions.add",
    "users.list",
    "users.edit"
  ],
  "status": "active"
}
'
{
  "success": true,
  "data": {
    "acknowledged": true,
    "modifiedCount": 0,
    "upsertedId": null,
    "upsertedCount": 0,
    "matchedCount": 1
  },
  "message": "User Institution updated!"
}

Authorizations

​
x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

​
userId
string
required

The unique identifier of the user

Body

application/json
​
accountType
string

The account type to update for the user

Example:

"admin"

​
entitlements
string[]

Array of entitlement permissions for the user institution

Example:
[
  "institutions.list",
  "institutions.add",
  "users.list",
  "users.edit"
]
​
status
string

The account status, active, pending

Example:

"active"

Response

User institution successfully updated

​
success
boolean

Indicates if the operation was successful

Example:

true

​
data
object
​
message
string

Success message

Example:

"User Institution updated!"