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": 0,
   "maxLength": 256,
   "description": "Title of the document"
  },
  "sort_order": {
   "type": "number",
   "minimum": 0,
   "exclusiveMinimum": 0
  },
  "publish_date": {
   "oneOf": [
    {
     "type": "string",
     "description": "Deadline. ISO 8601 format"
    },
    {
     "type": "null",
     "description": "Empty card description"
    }
   ]
  },
  "data": {
   "type": "object",
   "description": "Document content in ProseMirror JSON format. See document-schemas api to retrieve a schema"
  },
  "access": {
   "enum": [
    "for_everyone",
    "by_invite"
   ]
  },
  "parent_entity_uid": {
   "type": [
    "string",
    "null"
   ]
  },
  "for_everyone_access_role_id": {
   "type": "string"
  },
  "public": {
   "type": "boolean"
  },
  "redirect_url": {
   "type": [
    "string",
    "null"
   ]
  },
  "hidden_on_public_site": {
   "type": "boolean"
  },
  "backup_version": {
   "type": "number"
  },
  "published_version": {
   "oneOf": [
    {
     "type": "number",
     "description": "Version to publish on public site"
    },
    {
     "type": "null",
     "description": "No spicific version to publish on public site, current version will be published"
    },
    {
     "enum": [
      "current"
     ]
    }
   ]
  },
  "key": {
   "oneOf": [
    {
     "type": "string",
     "minLength": 2,
     "maxLength": 10,
     "pattern": "^[A-Z][A-Z0-9_]{1,9}$",
     "description": "Unique key for document, used in API and web interface. Must be unique across entire company"
    },
    {
     "type": "null",
     "description": "Reset existing key"
    }
   ]
  },
  "icon_type": {
   "oneOf": [
    {
     "enum": [
      "emoji",
      "material_icon"
     ],
     "description": "Type of icon"
    },
    {
     "type": "null",
     "description": "No icon"
    }
   ]
  },
  "icon_value": {
   "oneOf": [
    {
     "type": "string",
     "maxLength": 100,
     "description": "Icon value (emoji character or material icon name)"
    },
    {
     "type": "null",
     "description": "No icon value"
    }
   ]
  },
  "icon_color": {
   "oneOf": [
    {
     "type": "integer",
     "minimum": 1,
     "maximum": 17,
     "description": "Icon color index (1-17)"
    },
    {
     "type": "null",
     "description": "No icon color"
    }
   ]
  },
  "notification_period_start": {
   "oneOf": [
    {
     "type": "string",
     "description": "Notification period start date"
    },
    {
     "type": "null",
     "description": "Reset notification period start date"
    }
   ]
  },
  "notification_period_end": {
   "oneOf": [
    {
     "type": "string",
     "description": "Notification period end date"
    },
    {
     "type": "null",
     "description": "Reset notification period end date"
    }
   ]
  },
  "slug": {
   "oneOf": [
    {
     "type": "string",
     "minLength": 3,
     "maxLength": 128,
     "pattern": "^[a-z0-9-]+$",
     "description": "Human-readable URL slug. Lowercase latin letters, digits and hyphens only. Must be unique within the public site subtree"
    },
    {
     "type": "null",
     "description": "Reset slug (fall back to auto-slug generated from title)"
    }
   ]
  }
 },
 "anyOf": [
  {
   "required": [
    "title"
   ]
  },
  {
   "required": [
    "sort_order"
   ]
  },
  {
   "required": [
    "data"
   ]
  },
  {
   "required": [
    "access"
   ]
  },
  {
   "required": [
    "parent_entity_uid"
   ]
  },
  {
   "required": [
    "for_everyone_access_role_id"
   ]
  },
  {
   "required": [
    "public"
   ]
  },
  {
   "required": [
    "publish_date"
   ]
  },
  {
   "required": [
    "redirect_url"
   ]
  },
  {
   "required": [
    "hidden_on_public_site"
   ]
  },
  {
   "required": [
    "backup_version"
   ]
  },
  {
   "required": [
    "published_version"
   ]
  },
  {
   "required": [
    "key"
   ]
  },
  {
   "required": [
    "icon_type"
   ]
  },
  {
   "required": [
    "icon_value"
   ]
  },
  {
   "required": [
    "icon_color"
   ]
  },
  {
   "required": [
    "notification_period_start"
   ]
  },
  {
   "required": [
    "notification_period_end"
   ]
  },
  {
   "required": [
    "slug"
   ]
  }
 ]
}

Name	Type	Constraints	Description
title	string	minLength: 0 maxLength: 256	Title of the document
sort_order	number	minimum: 0 exclusiveMinimum: 0
publish_date	string		Deadline. ISO 8601 format
publish_date	null		Empty card description
data	object		Document content in ProseMirror JSON format. See document-schemas api to retrieve a schema
access	enum	[for_everyone,by_invite]
parent_entity_uid	string \| null
for_everyone_access_role_id	string
public	boolean
redirect_url	string \| null
hidden_on_public_site	boolean
backup_version	number
published_version	number		Version to publish on public site
	null		No spicific version to publish on public site, current version will be published
	enum	[current]
key	string	minLength: 2 maxLength: 10	Unique key for document, used in API and web interface. Must be unique across entire company
key	null		Reset existing key
icon_type	enum	[emoji,material_icon]	Type of icon
icon_type	null		No icon
icon_value	string	maxLength: 100	Icon value (emoji character or material icon name)
icon_value	null		No icon value
icon_color	integer	minimum: 1 maximum: 17	Icon color index (1-17)
icon_color	null		No icon color
notification_period_start	string		Notification period start date
notification_period_start	null		Reset notification period start date
notification_period_end	string		Notification period end date
notification_period_end	null		Reset notification period end date
slug	string	minLength: 3 maxLength: 128	Human-readable URL slug. Lowercase latin letters, digits and hyphens only. Must be unique within the public site subtree
slug	null		Reset slug (fall back to auto-slug generated from title)

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.ru

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!