Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Update column

PATCH

https://example.kaiten.ru/api/latest/boards/{board_id}/columns/{id}

⚠️ Starting late August, /api/column and column schemas will only use card_hide_after_days. The months_to_hide_cards attribute is deprecated and will be removed — update your code to use card_hide_after_days only.

Path parameters

Name	Type	Reference
board_idrequired	integer	Board ID
idrequired	integer	Column ID

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": 128,
   "description": "Title"
  },
  "sort_order": {
   "type": "number",
   "description": "Position",
   "exclusiveMinimum": 0
  },
  "type": {
   "enum": [
    1,
    2,
    3
   ],
   "description": "1 - queue, 2 – in progress, 3 – done"
  },
  "wip_limit": {
   "oneOf": [
    {
     "type": "integer",
     "description": "Work in progress recommended limit for column"
    },
    {
     "type": "null",
     "description": "Empty work in progress recommended limit for column"
    }
   ]
  },
  "wip_limit_type": {
   "enum": [
    1,
    2
   ],
   "description": "1 – card's count, 2 – card's size"
  },
  "last_moved_warning_after_days": {
   "type": "integer",
   "description": "Warning appears on stale cards"
  },
  "last_moved_warning_after_hours": {
   "type": "integer",
   "description": "Warning appears on stale cards"
  },
  "last_moved_warning_after_minutes": {
   "type": "integer",
   "description": "Warning appears on stale cards"
  },
  "col_count": {
   "type": "integer",
   "description": "Width"
  },
  "archive_after_days": {
   "type": "integer",
   "description": "Specify amount of days after which cards will be automatically archived. Works only for columns with type **done**"
  },
  "months_to_hide_cards": {
   "type": [
    "integer",
    "null"
   ],
   "description": "[Deprecated] Hide cards not moved for the last N months"
  },
  "card_hide_after_days": {
   "type": [
    "integer",
    "null"
   ],
   "description": "Hide cards not moved for the last N days"
  },
  "rules": {
   "type": "integer",
   "minimum": 0,
   "description": "Bit mask for column rules. Rules: 1 - checklists must be checked, 2 - display FIFO order"
  },
  "default_tags": {
   "type": [
    "string",
    "null"
   ],
   "description": "Default tags"
  },
  "prev_column_id": {
   "oneOf": [
    {
     "type": "integer",
     "description": "Column ID to move column before"
    },
    {
     "type": "null",
     "description": "Indicates that column should be moved to the beginning"
    }
   ]
  },
  "next_column_id": {
   "oneOf": [
    {
     "type": "integer",
     "description": "Column ID to move column after"
    },
    {
     "type": "null",
     "description": "Indicates that column should be moved to the end"
    }
   ]
  },
  "pause_sla": {
   "type": "boolean"
  }
 },
 "anyOf": [
  {
   "required": [
    "last_moved_warning_after_minutes"
   ]
  },
  {
   "required": [
    "last_moved_warning_after_hours"
   ]
  },
  {
   "required": [
    "last_moved_warning_after_days"
   ]
  },
  {
   "required": [
    "title"
   ]
  },
  {
   "required": [
    "sort_order"
   ]
  },
  {
   "required": [
    "type"
   ]
  },
  {
   "required": [
    "wip_limit"
   ]
  },
  {
   "required": [
    "wip_limit_type"
   ]
  },
  {
   "required": [
    "col_count"
   ]
  },
  {
   "required": [
    "archive_after_days"
   ]
  },
  {
   "required": [
    "months_to_hide_cards"
   ]
  },
  {
   "required": [
    "card_hide_after_days"
   ]
  },
  {
   "required": [
    "rules"
   ]
  },
  {
   "required": [
    "default_tags"
   ]
  },
  {
   "required": [
    "prev_column_id"
   ]
  },
  {
   "required": [
    "next_column_id"
   ]
  },
  {
   "required": [
    "pause_sla"
   ]
  }
 ]
}

Name	Type	Constraints	Description
title	string	minLength: 0 maxLength: 128	Title
sort_order	number	exclusiveMinimum: 0	Position
type	enum	[1,2,3]	1 - queue, 2 – in progress, 3 – done
wip_limit	integer		Work in progress recommended limit for column
wip_limit	null		Empty work in progress recommended limit for column
wip_limit_type	enum	[1,2]	1 – card's count, 2 – card's size
last_moved_warning_after_days	integer		Warning appears on stale cards
last_moved_warning_after_hours	integer		Warning appears on stale cards
last_moved_warning_after_minutes	integer		Warning appears on stale cards
col_count	integer		Width
archive_after_days	integer		Specify amount of days after which cards will be automatically archived. Works only for columns with type done
months_to_hide_cards	integer \| null		[Deprecated] Hide cards not moved for the last N months
card_hide_after_days	integer \| null		Hide cards not moved for the last N days
rules	integer	minimum: 0	Bit mask for column rules. Rules: 1 - checklists must be checked, 2 - display FIFO order
default_tags	string \| null		Default tags
prev_column_id	integer		Column ID to move column before
prev_column_id	null		Indicates that column should be moved to the beginning
next_column_id	integer		Column ID to move column after
next_column_id	null		Indicates that column should be moved to the end
pause_sla	boolean

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
updated	string	Last update timestamp
created	string	Create date
id	integer	Column id
title	string	Column title
sort_order	number	Position
col_count	integer	Width
wip_limit	integer	Recommended limit for column
type	enum	1 - queue, 2 – in progress, 3 – done
rules	integer	Bit mask for column rules. Rules: 1 - checklists must be checked, 2 - display FIFO order
board_id	integer	Board id
column_id	null	Parent column id
archive_after_days	integer	Specify amont of days after which cards will be automatically archived. Works only for columns with type done
wip_limit_type	enum	1 – card's count, 2 – card's size
external_id	null \| string	External id
default_tags	string	Default tags
last_moved_warning_after_days	integer	Warning appears on stale cards
last_moved_warning_after_hours	integer	Warning appears on stale cards
last_moved_warning_after_minutes	integer	Warning appears on stale cards
months_to_hide_cards	null \| integer	[Deprecated] Hide cards not moved for the last N months
card_hide_after_days	null \| integer	Hide cards not moved for the last N days

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.

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

board_id

Raw Body(json format)

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