Skip to content
forgit api docs

Update settings in current user's account

PATCH
/user/settings

Authorizations

Section titled “ Authorizations ”

Request Body

Section titled “ Request Body ”

UserSettingsOptions represents options to change user settings

object
description
string
diff_view_style
string
enable_repo_unit_hints
boolean
full_name
string
hide_activity
boolean
hide_email

Privacy

boolean
hide_pronouns
boolean
language
string
location
string
pronouns
string
theme
string
website
string
Example generated 
{
  "description": "example",
  "diff_view_style": "example",
  "enable_repo_unit_hints": true,
  "full_name": "example",
  "hide_activity": true,
  "hide_email": true,
  "hide_pronouns": true,
  "language": "example",
  "location": "example",
  "pronouns": "example",
  "theme": "example",
  "website": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

UserSettings

Media type application/json

UserSettings represents user settings

object
description
string
diff_view_style
string
enable_repo_unit_hints
boolean
full_name
string
hide_activity
boolean
hide_email

Privacy

boolean
hide_pronouns
boolean
language
string
location
string
pronouns
string
theme
string
website
string
Example generated 
{
  "description": "example",
  "diff_view_style": "example",
  "enable_repo_unit_hints": true,
  "full_name": "example",
  "hide_activity": true,
  "hide_email": true,
  "hide_pronouns": true,
  "language": "example",
  "location": "example",
  "pronouns": "example",
  "theme": "example",
  "website": "example"
}

401

Section titled “ 401 ”

APIUnauthorizedError is a unauthorized error response

Media type application/json
object
message
string
url
string
Example generated 
{
  "message": "example",
  "url": "example"
}

403

Section titled “ 403 ”

APIForbiddenError is a forbidden error response

Media type application/json
object
message
string
url
string
Example generated 
{
  "message": "example",
  "url": "example"
}