Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Update card

PATCH

https://example.kaiten.ru/api/latest/cards/{card_id}

Path parameters

Name	Type	Reference
card_idrequired	integer	Card ID

Headers

Name	Value
Content-Type	application/json

Attributes

schema

{
 "$schema": "http://json-schema.org/draft-06/schema",
 "type": "object",
 "properties": {
  "title": {
   "type": [
    "number",
    "string"
   ],
   "minLength": 1,
   "maxLength": 1024,
   "description": "Title"
  },
  "asap": {
   "type": "boolean",
   "description": "ASAP marker",
   "default": false
  },
  "due_date": {
   "oneOf": [
    {
     "type": "string",
     "description": "Deadline. ISO 8601 format"
    },
    {
     "type": "null",
     "description": "Empty card description"
    }
   ]
  },
  "due_date_time_present": {
   "type": "boolean",
   "description": "Flag indicating that deadline is specified up to hours and minutes"
  },
  "sort_order": {
   "type": "number",
   "exclusiveMinimum": 0,
   "description": "Position in the cell (board_id, column_id, lane_id)"
  },
  "description": {
   "oneOf": [
    {
     "type": [
      "number",
      "string"
     ],
     "maxLength": 32768,
     "description": "Description for card"
    },
    {
     "type": "null",
     "description": "Empty card description"
    }
   ]
  },
  "expires_later": {
   "type": "boolean",
   "description": "Fixed deadline or not. Date dependant flag in terms of Kanban"
  },
  "size_text": {
   "oneOf": [
    {
     "type": [
      "number",
      "string"
     ],
     "maxLength": 267,
     "description": "Size. Example of acceptable values: '1', '23.45', '.5', 'S', '3 M', 'L', 'XL', etc..."
    },
    {
     "type": "null",
     "description": "Empty size text"
    }
   ]
  },
  "board_id": {
   "type": "integer",
   "description": "Board ID"
  },
  "column_id": {
   "type": "integer",
   "description": "Column ID"
  },
  "lane_id": {
   "type": "integer",
   "description": "Lane ID"
  },
  "owner_id": {
   "type": "integer",
   "description": "Owner ID"
  },
  "type_id": {
   "type": "integer",
   "description": "Card type ID"
  },
  "service_id": {
   "oneOf": [
    {
     "type": "integer",
     "description": "Service ID"
    },
    {
     "type": "null",
     "description": "Empty service ID"
    }
   ]
  },
  "blocked": {
   "type": "boolean",
   "description": "Send false to release all blocks related to this card"
  },
  "condition": {
   "enum": [
    1,
    2
   ],
   "description": "1 - live, 2 - archived, 3 - deleted"
  },
  "external_id": {
   "oneOf": [
    {
     "type": [
      "number",
      "string"
     ],
     "maxLength": 1024,
     "description": "Any external id you want to assign to card. Not exposed in web interface"
    },
    {
     "type": "null",
     "description": "Any external id you want to assign to card. Not exposed in web interface"
    }
   ]
  },
  "text_format_type_id": {
   "enum": [
    1,
    2,
    3
   ],
   "description": "1 - markdown (default), 2 – html, 3 - jira wiki format"
  },
  "sd_new_comment": {
   "type": "boolean",
   "description": "Has unseen Service Desk request author comments"
  },
  "owner_email": {
   "type": "string",
   "description": "Owner email address"
  },
  "prev_card_id": {
   "type": "integer",
   "description": "Specifies optional ID of the card that was previous one and will be positioned after the current card after repositioning"
  },
  "estimate_workload": {
   "type": "number",
   "minimum": 0,
   "description": "Card estimate workload"
  },
  "properties": {
   "type": "object",
   "description": "To update custom properties. Format: 'id_{custom_property_id}: value'. Value can be a null, number, string, array or object. To delete a property from card, pass null as the value"
  }
 }
}

Name	Type	Constraints	Description
title	number \| string		Title
asap	boolean default:false		ASAP marker
due_date	string		Deadline. ISO 8601 format
due_date	null		Empty card description
due_date_time_present	boolean		Flag indicating that deadline is specified up to hours and minutes
sort_order	number	exclusiveMinimum: 0	Position in the cell (board_id, column_id, lane_id)
description	number \| string		Description for card
description	null		Empty card description
expires_later	boolean		Fixed deadline or not. Date dependant flag in terms of Kanban
size_text	number \| string		Size. Example of acceptable values: '1', '23.45', '.5', 'S', '3 M', 'L', 'XL', etc...
size_text	null		Empty size text
board_id	integer		Board ID
column_id	integer		Column ID
lane_id	integer		Lane ID
owner_id	integer		Owner ID
type_id	integer		Card type ID
service_id	integer		Service ID
service_id	null		Empty service ID
blocked	boolean		Send false to release all blocks related to this card
condition	enum	[1,2]	1 - live, 2 - archived, 3 - deleted
external_id	number \| string \| null		Any external id you want to assign to card. Not exposed in web interface
text_format_type_id	enum	[1,2,3]	1 - markdown (default), 2 – html, 3 - jira wiki format
sd_new_comment	boolean		Has unseen Service Desk request author comments
owner_email	string		Owner email address
prev_card_id	integer		Specifies optional ID of the card that was previous one and will be positioned after the current card after repositioning
estimate_workload	number	minimum: 0	Card estimate workload
properties	object		To update custom properties. Format: 'id_{custom_property_id}: value'. Value can be a null, number, string, array or object. To delete a property from card, pass null as the value

Responses

200

Description	Response type	Example
Success	Objects	Open

Response Attributes

Name	Type	Description
updated	string	Last update timestamp
created	string	Create date
archived	boolean	Card archived flag
id	integer	Card id
title	string	Card title
description	null \| string	Card description
asap	boolean	Card asap flag
due_date	null \| string	Card deadline
sort_order	number	Position
fifo_order	integer	Number of card in the cell when fifo rule applied to cards column
state	enum	1-queued, 2-inProgresss, 3-done
condition	enum	1 - live, 2 - archived
expires_later	boolean	Fixed deadline or not. Date dependant flag in terms of Kanban
parents_count	integer	Card parents count
children_count	integer	Card children count
children_done	integer	Card children done count
has_blocked_children	boolean	Flag indicating that card has blocked children
goals_total	integer	Card goals count
goals_done	integer	Number of card done goals
time_spent_sum	integer	Amount of time spent(in minutes)
time_blocked_sum	integer	Amount of blocked time(in minutes)
children_number_properties_sum	null \| object Schema	Sum according to numerical data of child cards
calculated_planned_start	null \| string	Calculated planned start
calculated_planned_end	null \| string	Calculated planned end
parent_checklist_ids	null \| array	Array of card parent checklist ids
parents_ids	null \| array	Array of card parent ids
children_ids	null \| array	Array of card children ids
blocking_card	boolean	Is card blocking another card
blocked	boolean	Is card blocked
size	null \| number	Numerical part of size
size_unit	null \| string	Text part of size
size_text	null \| string	Size. Example of acceptable values: '1', '23.45', '.5', 'S', '3 M', 'L', 'XL', etc...
due_date_time_present	boolean	Flag indicating that deadline is specified up to hours and minutes
board_id	integer	Board id
column_id	integer	Column id
lane_id	integer	Lane id
owner_id	integer	Card owner id
type_id	integer	Card type id
version	integer	Card version
updater_id	integer	User id who last updated card
completed_on_time	null \| boolean	Flag indicating that card completed on time when due date present
completed_at	null \| string	Date when card moved to done type column
last_moved_at	null \| string	Date when card last moved
lane_changed_at	null \| string	Date when card changed lane
column_changed_at	null \| string	Date when card changed column
first_moved_to_in_progress_at	null \| string	Date when card first moved to inProgress type column
last_moved_to_done_at	null \| string	Date when card last moved to done type column
sprint_id	integer	Sprint id
external_id	null \| string	External id
service_id	integer	Service id
comments_total	integer	Total card comments
comment_last_added_at	null \| string	Date when last comment added
properties	null \| object Schema	Card custom properties. Format: id_{propertyId}:value
planned_start	null \| string	Card timeline planned start
planned_end	null \| string	Card timeline planned end
counters_recalculated_at	string	Date of recalculating counters
sd_new_comment	boolean	Has unseen service desk request author comments
import_id	null \| integer	Import id
public	boolean	Is card public
share_settings	null \| object Schema	Public share settings
share_id	null \| string	Public share id
external_user_emails	null \| string	External users emails
description_filled	boolean	Flag indicating that card has description
estimate_workload	number	Estimate_workload
owner	object Schema	Card owner info
members	array of objects Schema	Card members
tags	array Schema	Card tags
source	enum \| null	app, api, email, telegram, slack, webhook, import, schedule, automation

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.

Examples

How to

link the card to the service

{
  "service_id": 1,
  "owner_email": "jonh_doe@example.com"
}

get service_id

change request owner

{
  "owner_id": 1
}

get owner_id

How to update custom property type:

String

{
  "properties": {
    "id_1": "test"
  }
}

Properties format: 'id_{custom_property_id}: value'

get custom_property_id

Url

{
  "properties": {
    "id_2": "https://www.google.com/"
  }
}

Properties format: 'id_{custom_property_id}: value'

get custom_property_id

Number

{
  "properties": {
    "id_3": 12
  }
}

Properties format: 'id_{custom_property_id}: value'

get custom_property_id

Email

{
  "properties": {
    "id_4": "email@gmail.com"
  }
}

Properties format: 'id_{custom_property_id}: value'

get custom_property_id

Phone

{
  "properties": {
    "id_5": "+7 (785) 421-47-89"
  }
}

Format: 'id_{custom_property_id}: value'

get custom_property_id

Select

{
  "properties": {
    "id_6": [
      12
    ]
  }
}

Properties format: 'id_{custom_property_id}: value'. Value array must contain select option id

get custom_property_id

get select options

Multi select

{
  "properties": {
    "id_6": [
      12,
      13
    ]
  }
}

Properties format: 'id_{custom_property_id}: value'. Value array must contain select option ids

get custom_property_id

get select options

Date

{
  "properties": {
    "id_6": {
      "date": "2022-09-30",
      "time": "19:00:36",
      "tzOffset": 180
    }
  }
}

get custom_property_id

Catalog

{
  "properties": {
    "id_7": "3"
  }
}

Properties format: 'id_{custom_property_id}: value'. Value must contain catalog value id

get custom_property_id

get catalog value

Collective value

{
  "properties": {
    "id_8": "my_score"
  }
}

Properties format: 'id_{custom_property_id}: value'. Value must be text or a number, depending on the type collective value

get custom_property_id

Rating

{
  "properties": {
    "id_9": 1
  }
}

Properties format: 'id_{custom_property_id}: value'

get custom_property_id

Emoji set

{
  "properties": {
    "id_10": [
      {
        "emoji": "🙂",
        "count": 1
      }
    ]
  }
}

Properties format: 'id_{custom_property_id}: value'

get custom_property_id

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

card_id

Raw Body(json format)

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