Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Update document

PATCH

https://example.kaiten.ru/api/latest/documents/{document_uid}

Path parameters

Name	Type	Reference
document_uidrequired	string	Document 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 title"
  },
  "data": {
   "type": "object",
   "description": "Document content in ProseMirror JSON format"
  },
  "parent_entity_uid": {
   "type": [
    "string",
    "null"
   ],
   "description": "Parent tree entity uid. Used to move document in the tree"
  },
  "sort_order": {
   "type": "number",
   "minimum": 0,
   "exclusiveMinimum": 0,
   "description": "Sort order"
  },
  "for_everyone_access_role_id": {
   "type": [
    "string",
    "null"
   ],
   "format": "uuid",
   "description": "Role id for everyone access"
  },
  "access": {
   "enum": [
    "for_everyone",
    "by_invite"
   ],
   "description": "Document access type"
  },
  "published_version": {
   "oneOf": [
    {
     "type": "integer",
     "description": "Version number to publish"
    },
    {
     "type": "string",
     "enum": [
      "current"
     ],
     "description": "Publish current version"
    }
   ],
   "description": "Version to publish"
  },
  "backup_version": {
   "type": "integer",
   "description": "Version number to restore. Triggers document restore when provided"
  },
  "key": {
   "type": [
    "string",
    "null"
   ],
   "maxLength": 256,
   "description": "Unique document key within company. Cannot be changed once set"
  },
  "publish_date": {
   "type": [
    "string",
    "null"
   ],
   "description": "Publication date"
  },
  "redirect_url": {
   "type": [
    "string",
    "null"
   ],
   "description": "Redirect URL"
  },
  "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 on public site"
  },
  "notification_period_start": {
   "type": [
    "string",
    "null"
   ],
   "description": "Notification period start date. Must be sent together with notification_period_end"
  },
  "notification_period_end": {
   "type": [
    "string",
    "null"
   ],
   "description": "Notification period end date. Must be sent together with notification_period_start"
  }
 },
 "anyOf": [
  {
   "required": [
    "title"
   ]
  },
  {
   "required": [
    "data"
   ]
  },
  {
   "required": [
    "parent_entity_uid"
   ]
  },
  {
   "required": [
    "sort_order"
   ]
  },
  {
   "required": [
    "published_version"
   ]
  },
  {
   "required": [
    "backup_version"
   ]
  },
  {
   "required": [
    "key"
   ]
  },
  {
   "required": [
    "access"
   ]
  },
  {
   "required": [
    "hidden_on_public_site"
   ]
  },
  {
   "required": [
    "icon_type"
   ]
  }
 ]
}

Name	Type	Constraints	Description
title	string	minLength: 1 maxLength: 256	Document title
data	object		Document content in ProseMirror JSON format
parent_entity_uid	string \| null		Parent tree entity uid. Used to move document in the tree
sort_order	number	minimum: 0 exclusiveMinimum: 0	Sort order
for_everyone_access_role_id	string \| null		Role id for everyone access
access	enum	[for_everyone,by_invite]	Document access type
published_version	integer		Version number to publish
published_version	string		Publish current version
backup_version	integer		Version number to restore. Triggers document restore when provided
key	string \| null		Unique document key within company. Cannot be changed once set
publish_date	string \| null		Publication date
redirect_url	string \| null		Redirect URL
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 on public site
notification_period_start	string \| null		Notification period start date. Must be sent together with notification_period_end
notification_period_end	string \| null		Notification period end date. Must be sent together with notification_period_start

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
uid	string	Document uid
id	integer	Document id
title	string	Document title
created	string	Create date
updated	string	Last update timestamp
archived	boolean	Document archived flag
company_id	integer	Company id
author_id	integer	Author user id
parent_entity_uid	null \| string	Parent tree entity uid
group_idDeprecated: use parent_entity_uid instead	null \| string	Deprecated alias for parent_entity_uid
entity_type	string	Entity type. Always "document"
sort_order	number	Document sort order
access	enum	Document access type
for_everyone_access_role_id	null \| string	Role id for everyone access
data	object	Document content in ProseMirror JSON format
version	integer	Current document version number
published_version	null \| integer	Published version number
publish_date	null \| string	Publication date
public	boolean	Is document publicly available (legacy field)
hidden_on_public_site	boolean	Document is hidden on public site
key	null \| string	Unique document key within company
redirect_url	null \| string	Redirect URL
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
path	string	Inner path to entity in tree
schema_version	integer	ProseMirror schema version
notification_period_start	null \| string	Notification period start date
notification_period_end	null \| string	Notification period end date

400

Description	Response type	Example
Validation error	Object	Open

Response Attributes

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

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 or has unfinished key operations	Object	Open

Response Attributes

Name	Type	Description
message	string	Error message
code	string	Error 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

document_uid

Raw Body(json format)

  1  curl --request PATCH \
  2       --url 'https://example.kaiten.ru/api/latest/documents/{document_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!