Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Update document group

PATCH

https://example.kaiten.ru/api/latest/document-groups/{document_group_uid}

Path parameters

Name	Type	Reference
document_group_uidrequired	string	Document group UID

Headers

Name	Value
Content-Type	application/json

Attributes

schema

{
 "$schema": "http://json-schema.org/draft-06/schema",
 "type": "object",
 "properties": {
  "title": {
   "type": "string",
   "minLength": 1,
   "maxLength": 256,
   "description": "Document group title"
  },
  "parent_entity_uid": {
   "type": [
    "string",
    "null"
   ],
   "description": "Parent tree entity uid. Used to move document group in the tree"
  },
  "sort_order": {
   "type": "number",
   "minimum": 0,
   "exclusiveMinimum": 0,
   "description": "Sort order"
  },
  "access": {
   "enum": [
    "for_everyone",
    "by_invite"
   ],
   "description": "Document group access type"
  },
  "for_everyone_access_role_id": {
   "type": [
    "string",
    "null"
   ],
   "format": "uuid",
   "description": "Role id for everyone access"
  },
  "hostname": {
   "type": [
    "string",
    "null"
   ],
   "maxLength": 30,
   "description": "Custom hostname for public site. Can contain only letters, numbers and «-», length 2–30 symbols, cannot end with «-»"
  },
  "redirect_url": {
   "type": [
    "string",
    "null"
   ],
   "description": "Redirect URL"
  },
  "key": {
   "type": [
    "string",
    "null"
   ],
   "maxLength": 256,
   "description": "Unique document group key within company. Cannot be changed once set"
  },
  "icon_type": {
   "type": [
    "string",
    "null"
   ],
   "enum": [
    "material_icon",
    null
   ],
   "description": "Icon type"
  },
  "icon_value": {
   "type": [
    "string",
    "null"
   ],
   "description": "Icon value (icon name for material_icon type)"
  },
  "icon_color": {
   "type": [
    "integer",
    "null"
   ],
   "description": "Icon color"
  },
  "hidden_on_public_site": {
   "type": "boolean",
   "description": "Hide document group on public site"
  },
  "news_feed": {
   "type": "boolean",
   "description": "Mark document group as news feed. Requires hostname to be set on this folder or one of its parent folders"
  },
  "index_document_uid": {
   "type": [
    "string",
    "null"
   ],
   "format": "uuid",
   "description": "UID of the document to use as the home page for this folder. Requires hostname to be set on this folder. Document must be within the document group tree, not archived and not hidden on public site"
  }
 },
 "anyOf": [
  {
   "required": [
    "title"
   ]
  },
  {
   "required": [
    "parent_entity_uid"
   ]
  },
  {
   "required": [
    "sort_order"
   ]
  },
  {
   "required": [
    "access"
   ]
  },
  {
   "required": [
    "hostname"
   ]
  },
  {
   "required": [
    "key"
   ]
  },
  {
   "required": [
    "icon_type"
   ]
  },
  {
   "required": [
    "hidden_on_public_site"
   ]
  },
  {
   "required": [
    "news_feed"
   ]
  },
  {
   "required": [
    "index_document_uid"
   ]
  }
 ]
}

Name	Type	Constraints	Description
title	string	minLength: 1 maxLength: 256	Document group title
parent_entity_uid	string \| null		Parent tree entity uid. Used to move document group in the tree
sort_order	number	minimum: 0 exclusiveMinimum: 0	Sort order
access	enum	[for_everyone,by_invite]	Document group access type
for_everyone_access_role_id	string \| null		Role id for everyone access
hostname	string \| null		Custom hostname for public site. Can contain only letters, numbers and «-», length 2–30 symbols, cannot end with «-»
redirect_url	string \| null		Redirect URL
key	string \| null		Unique document group key within company. Cannot be changed once set
icon_type	string \| null		Icon type
icon_value	string \| null		Icon value (icon name for material_icon type)
icon_color	integer \| null		Icon color
hidden_on_public_site	boolean		Hide document group on public site
news_feed	boolean		Mark document group as news feed. Requires hostname to be set on this folder or one of its parent folders
index_document_uid	string \| null		UID of the document to use as the home page for this folder. Requires hostname to be set on this folder. Document must be within the document group tree, not archived and not hidden on public site

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
uid	string	Document group uid
id	integer	Document group id
title	string	Document group title
created	string	Create date
updated	string	Last update timestamp
archived	boolean	Document group archived flag
company_id	integer	Company id
author_id	integer	Author user id
parent_entity_uid	null \| string	Parent tree entity uid
parent_group_idDeprecated: use parent_entity_uid instead	null \| string	Deprecated alias for parent_entity_uid
entity_type	string	Entity type. Always "document_group"
sort_order	number	Document group sort order
access	enum	Document group access type
for_everyone_access_role_id	null \| string	Role id for everyone access
hostname	null \| string	Custom hostname for public site
redirect_url	null \| string	Redirect URL
key	null \| string	Unique document group key within company
icon_type	null \| string	Icon type. "material_icon" or null
icon_value	null \| string	Icon value (icon name for material_icon type)
icon_color	null \| integer	Icon color
public	boolean	Is document group publicly available (legacy field)
news_feed	boolean	Is document group marked as news feed
hidden_on_public_site	boolean	Document group is hidden on public site
path	string	Inner path to entity in tree
index_document_uid	null \| string	UID of the document used as the home page for this folder

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.

402

Description	Response type	Example
Feature is not supported by tariff	Object	Open

Response Attributes

Name	Type	Description
message	string	Error message

403

Description	Response type	Example
Forbidden		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.

409

Description	Response type	Example
Conflict — key already in use, hostname already in use, or unfinished key operations	Object	Open

Response Attributes

Name	Type	Description
message	string	Error message
code	string	Error code (optional)

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

document_group_uid

Raw Body(json format)

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

Response

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