Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Update board

PATCH

https://example.kaiten.ru/api/latest/spaces/{space_id}/boards/{id}

Path parameters

Name	Type	Reference
space_idrequired	integer	Space ID
idrequired	integer	Board ID

Headers

Name	Value
Content-Type	application/json

Attributes

schema

{
 "$schema": "http://json-schema.org/draft-06/schema",
 "type": "object",
 "properties": {
  "title": {
   "oneOf": [
    {
     "type": "string",
     "minLength": 1,
     "maxLength": 128,
     "description": "Title of the new board"
    },
    {
     "type": "number"
    }
   ]
  },
  "description": {
   "oneOf": [
    {
     "type": "string",
     "description": "Description"
    },
    {
     "type": "null",
     "description": "Description"
    }
   ]
  },
  "top": {
   "type": "integer",
   "description": "Y coordinate of the board on space"
  },
  "left": {
   "type": "integer",
   "description": "X coordinate of the board on space"
  },
  "type": {
   "enum": [
    1,
    5
   ],
   "description": "1 - place on space with coordinates (top, left), 5 - attach to space as sidebar"
  },
  "cell_wip_limits": {
   "type": "array",
   "description": "JSON containing wip limits rules for cells"
  },
  "default_card_type_id": {
   "type": "integer",
   "description": "Default card type for new cards on board"
  },
  "default_tags": {
   "type": [
    "string",
    "null"
   ],
   "description": "Default tags"
  },
  "first_image_is_cover": {
   "type": "boolean",
   "description": "Automatically mark first uploaded card's image as card's cover"
  },
  "reset_lane_spent_time": {
   "type": "boolean",
   "description": "Reset lane spent time when card changed lane"
  },
  "automove_cards": {
   "type": "boolean",
   "description": "Automatically move cards depending on their children state"
  },
  "backward_moves_enabled": {
   "type": "boolean",
   "description": "Allow automatic backward movement for summary boards"
  },
  "move_parents_to_done": {
   "type": "boolean",
   "description": "Automatically move parent cards to done when their children cards on this board is done"
  },
  "hide_done_policies": {
   "type": "boolean",
   "description": "Hide done checklist policies"
  },
  "hide_done_policies_in_done_column": {
   "type": "boolean",
   "description": "Hide done checklist policies only in done column"
  },
  "sort_order": {
   "type": "number",
   "description": "Position",
   "exclusiveMinimum": 0
  },
  "external_id": {
   "oneOf": [
    {
     "type": [
      "number",
      "string"
     ],
     "maxLength": 1024,
     "description": "Any external id you want to assign to board. Not exposed in web interface"
    },
    {
     "type": "null",
     "description": "Any external id you want to assign to board. Not exposed in web interface"
    }
   ]
  },
  "move_from_space_id": {
   "type": "integer",
   "description": "Move board from space"
  },
  "auto_assign_enabled": {
   "type": "boolean",
   "description": "Automatically assign the author as a member (or responsible if the first member) when a card is moved to the column with type \"in progress\" or \"done\""
  },
  "card_properties": {
   "oneOf": [
    {
     "type": "array",
     "items": {
      "type": "object",
      "properties": {
       "key": {
        "type": "string"
       },
       "required": {
        "type": "boolean"
       },
       "laneIds": {
        "oneOf": [
         {
          "type": "array"
         },
         {
          "type": "null"
         }
        ]
       },
       "columnIds": {
        "oneOf": [
         {
          "type": "array"
         },
         {
          "type": "null"
         }
        ]
       },
       "cardTypeIds": {
        "oneOf": [
         {
          "type": "array"
         },
         {
          "type": "null"
         }
        ]
       }
      }
     },
     "description": "Suggested to fill card properties"
    },
    {
     "type": "null",
     "description": "Empty suggested to fill card properties"
    }
   ]
  }
 },
 "anyOf": [
  {
   "required": [
    "title"
   ]
  },
  {
   "required": [
    "external_id"
   ]
  },
  {
   "required": [
    "description"
   ]
  },
  {
   "required": [
    "top"
   ]
  },
  {
   "required": [
    "left"
   ]
  },
  {
   "required": [
    "type"
   ]
  },
  {
   "required": [
    "cell_wip_limits"
   ]
  },
  {
   "required": [
    "default_card_type_id"
   ]
  },
  {
   "required": [
    "default_tags"
   ]
  },
  {
   "required": [
    "first_image_is_cover"
   ]
  },
  {
   "required": [
    "reset_lane_spent_time"
   ]
  },
  {
   "required": [
    "automove_cards"
   ]
  },
  {
   "required": [
    "backward_moves_enabled"
   ]
  },
  {
   "required": [
    "move_parents_to_done"
   ]
  },
  {
   "required": [
    "hide_done_policies"
   ]
  },
  {
   "required": [
    "hide_done_policies_in_done_column"
   ]
  },
  {
   "required": [
    "auto_assign_enabled"
   ]
  },
  {
   "required": [
    "move_from_space_id"
   ]
  },
  {
   "required": [
    "card_properties"
   ]
  }
 ]
}

Name	Type	Constraints	Description
title	string	minLength: 1 maxLength: 128	Title of the new board
title	number
description	string \| null		Description
top	integer		Y coordinate of the board on space
left	integer		X coordinate of the board on space
type	enum	[1,5]	1 - place on space with coordinates (top, left), 5 - attach to space as sidebar
cell_wip_limits	array		JSON containing wip limits rules for cells
default_card_type_id	integer		Default card type for new cards on board
default_tags	string \| null		Default tags
first_image_is_cover	boolean		Automatically mark first uploaded card's image as card's cover
reset_lane_spent_time	boolean		Reset lane spent time when card changed lane
automove_cards	boolean		Automatically move cards depending on their children state
backward_moves_enabled	boolean		Allow automatic backward movement for summary boards
move_parents_to_done	boolean		Automatically move parent cards to done when their children cards on this board is done
hide_done_policies	boolean		Hide done checklist policies
hide_done_policies_in_done_column	boolean		Hide done checklist policies only in done column
sort_order	number	exclusiveMinimum: 0	Position
external_id	number \| string \| null		Any external id you want to assign to board. Not exposed in web interface
move_from_space_id	integer		Move board from space
auto_assign_enabled	boolean		Automatically assign the author as a member (or responsible if the first member) when a card is moved to the column with type "in progress" or "done"
card_properties	array of objects Schema		Suggested to fill card properties
card_properties	null		Empty suggested to fill card properties

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
created	string	Create date
updated	string	Last update timestamp
id	integer	Board id
title	string	Board title
cell_wip_limits	null \| array	JSON containing wip limits rules for cells
external_id	null \| string	External id
default_card_type_id	integer	Default card type for new cards on board
description	string	Board description
email_key	string	Email key
move_parents_to_done	boolean	Automatically move parent cards to done when their children cards on this board is done
default_tags	null \| string	Default tags
first_image_is_cover	boolean	Automatically mark first uploaded card's image as card's cover
reset_lane_spent_time	boolean	Reset lane spent time when card changed lane
backward_moves_enabled	boolean	Allow automatic backward movement for summary boards
hide_done_policies	boolean	Hide done checklist policies
hide_done_policies_in_done_column	boolean	Hide done checklist policies only in done column
automove_cards	boolean	Automatically move cards depending on their children state
auto_assign_enabled	boolean	Automatically assign a user to the card when he/she moves the card if the user is not a member of the card
card_properties	null \| array of objects Schema	Properties of the board cards suggested for filling
columns	array of objects Schema	Board columns
lanes	array of objects Schema	Board lanes
top	integer	Y coordinate of the board on space
left	integer	X coordinate of the board on space
sort_order	number	Position

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

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

space_id

Raw Body(json format)

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