Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Update user

PATCH

https://example.kaiten.ru/api/latest/users/{id}

Path parameters

Name	Type	Reference
idrequired	integer	User ID

Headers

Name	Value
Content-Type	application/json

Attributes

schema

{
 "$schema": "http://json-schema.org/draft-06/schema",
 "type": "object",
 "properties": {
  "username": {
   "type": "string",
   "pattern": "^[0-9a-zA-Zа-яА-Я_]{1,}$",
   "description": "Username for mentions and login"
  },
  "full_name": {
   "type": "string",
   "minLength": 1,
   "maxLength": 128,
   "description": "Full name"
  },
  "initials": {
   "type": "string",
   "minLength": 2,
   "maxLength": 2,
   "description": "Initials"
  },
  "avatar_type": {
   "enum": [
    1,
    2,
    3
   ],
   "description": "1 – gravatar, 2 – initials, 3 - uploaded"
  },
  "password": {
   "type": "string",
   "minLength": 6,
   "description": "New password"
  },
  "old_password": {
   "oneOf": [
    {
     "type": "string",
     "minLength": 6,
     "description": "Old password"
    },
    {
     "type": "null",
     "description": "Old password"
    }
   ]
  },
  "lng": {
   "type": "string",
   "description": "Language"
  },
  "default_space_id": {
   "oneOf": [
    {
     "type": "integer",
     "description": "Default space"
    },
    {
     "type": "null",
     "description": "Default space"
    }
   ]
  },
  "theme": {
   "enum": [
    "light",
    "dark",
    "auto"
   ],
   "description": "light - light color theme, dark - dark color theme, auto - color theme based on OS settings"
  },
  "email_frequency": {
   "enum": [
    1,
    2
   ],
   "description": "1 - never, 2 – instantly"
  },
  "timezone": {
   "type": "string",
   "description": "Time zone"
  },
  "subject_by": {
   "enum": [
    1,
    2
   ],
   "description": "1 - id and title, 2 – action"
  },
  "email_settings": {
   "type": "object",
   "description": "Email settings"
  },
  "telegram_settings": {
   "type": "object",
   "description": "Telegram settings"
  },
  "slack_settings": {
   "type": "object",
   "description": "Slack settings"
  },
  "notification_enabled_channels": {
   "type": "array",
   "items": {
    "enum": [
     "inner",
     "mobile_app",
     "email",
     "slack",
     "telegram"
    ]
   },
   "description": "List of enabled channels for notifications"
  },
  "notification_settings": {
   "type": "object",
   "description": "Channel lists where notifications for specified events should be sent"
  },
  "ui_version": {
   "enum": [
    1,
    2
   ],
   "description": "1 - old ui. 2 - new ui"
  }
 },
 "anyOf": [
  {
   "required": [
    "username"
   ]
  },
  {
   "required": [
    "full_name"
   ]
  },
  {
   "required": [
    "initials"
   ]
  },
  {
   "required": [
    "avatar_type"
   ]
  },
  {
   "required": [
    "password"
   ]
  },
  {
   "required": [
    "lng"
   ]
  },
  {
   "required": [
    "default_space_id"
   ]
  },
  {
   "required": [
    "email_frequency"
   ]
  },
  {
   "required": [
    "timezone"
   ]
  },
  {
   "required": [
    "subject_by"
   ]
  },
  {
   "required": [
    "email_settings"
   ]
  },
  {
   "required": [
    "telegram_settings"
   ]
  },
  {
   "required": [
    "slack_settings"
   ]
  },
  {
   "required": [
    "theme"
   ]
  },
  {
   "required": [
    "notification_enabled_channels"
   ]
  },
  {
   "required": [
    "notification_settings"
   ]
  },
  {
   "required": [
    "ui_version"
   ]
  }
 ]
}

Name	Type	Constraints	Description
username	string		Username for mentions and login
full_name	string	minLength: 1 maxLength: 128	Full name
initials	string	minLength: 2 maxLength: 2	Initials
avatar_type	enum	[1,2,3]	1 – gravatar, 2 – initials, 3 - uploaded
password	string	minLength: 6	New password
old_password	string \| null	minLength: 6	Old password
lng	string		Language
default_space_id	integer \| null		Default space
theme	enum	[light,dark,auto]	light - light color theme, dark - dark color theme, auto - color theme based on OS settings
email_frequency	enum	[1,2]	1 - never, 2 – instantly
timezone	string		Time zone
subject_by	enum	[1,2]	1 - id and title, 2 – action
email_settings	object		Email settings
telegram_settings	object		Telegram settings
slack_settings	object		Slack settings
notification_enabled_channels	array	[ inner, mobile_app, email, slack, telegram ]	List of enabled channels for notifications
notification_settings	object		Channel lists where notifications for specified events should be sent
ui_version	enum	[1,2]	1 - old ui. 2 - new ui

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
id	integer	User id
full_name	string	User full name
email	string	User email
username	string	Username for mentions and login
updated	string	Last update timestamp
created	string	Create date
avatar_initials_url	string	Default user avatar
avatar_uploaded_url	null \| string	User uploaded avatar url
activated	boolean	User activated flag
initials	string	User initials
avatar_type	enum	1 – gravatar, 2 – initials, 3 - uploaded
lng	string	Language
sd_telegram_id	integer	Service desk telegram id
timezone	string	Time zone
news_subscription	boolean	news subscription flag
theme	enum	light - light color theme, dark - dark color theme, auto - color theme based on OS settings
ui_version	enum	1 - old ui. 2 - new ui
default_space_id	null \| integer	Default space
email_frequency	enum	1 - never, 2 – instantly
email_settings	object Schema	Email settings
work_time_settings	object Schema	Work time settings
telegram_id	integer	Telegram id
telegram_settings	object	Telegram settings
has_password	boolean	Has user password flag

400

Description	Response type	Example
Validation error	Object	Open

Response Attributes

Name	Type	Description
message	string	Error message

401

Description	Response type	Example
Invalid token	String	Open

A schema has not been defined for this response code.

403

Description	Response type	Example
Forbiden		Response body does not exist

A schema has not been defined for this response code.

404

Description	Response type	Example
Not found		Response body does not exist

A schema has not been defined for this response code.

Kaiten

Addons terms of use Personal data processing policy

If you have any questions or need help with integration feel free to write us at support@kaiten.io

Company domain

Path Parameters

Raw Body(json format)

  1  curl --request PATCH \
  2       --url 'https://example.kaiten.ru/api/latest/users/{id}' \
  3       --header 'Accept: application/json' \
  4       --header 'Content-Type: application/json'
  5

Response

ClickTry It!to start a request and see the response here!