Skip to main content
PUT
/
api
/
user
/
institution
Update institution settings
curl --request PUT \
  --url http://localhost:3000/api/user/institution \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "ainame": "<string>",
  "about": "<string>",
  "picture": "<string>",
  "picture_animated": "<string>",
  "css": "<string>",
  "contactEmail": "[email protected]",
  "questionType": "<string>",
  "allowJoining": "disabled",
  "joiningAdminOnly": true
}
'
{
  "success": true,
  "message": "<string>"
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
ainame
string

AI assistant display name

about
string

About text for the institution

picture
string

Institution logo URL

picture_animated
string

Animated logo URL

css
string

Custom CSS for branding

contactEmail
string<email>

Contact email for the institution

questionType
string

Default question type

allowJoining
enum<string>

Whether new users can join

Available options:
disabled,
enabled,
approval
joiningAdminOnly
boolean

Whether only admins can approve joins

Response

Institution updated successfully

success
boolean
Example:

true

message
string

Success message