Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Add checklist to card

POST

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

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": {
  "name": {
   "type": "string",
   "minLength": 1,
   "maxLength": 1024,
   "description": "Name"
  },
  "sort_order": {
   "type": "number",
   "description": "Position",
   "exclusiveMinimum": 0
  },
  "items_source_checklist_id": {
   "type": "integer",
   "minimum": 1,
   "description": "Checklist id to copy list items from"
  },
  "exclude_item_ids": {
   "type": "array",
   "items": {
    "type": "integer"
   },
   "description": "If source id is presented, these ids will be used to not include list items in created checklist"
  },
  "source_share_id": {
   "type": "integer",
   "minimum": 1,
   "description": "Share checklist id"
  }
 },
 "anyOf": [
  {
   "required": [
    "name"
   ]
  },
  {
   "required": [
    "source_share_id"
   ]
  }
 ]
}

Name	Type	Constraints	Description
name	string	minLength: 1 maxLength: 1024	Name
sort_order	number	exclusiveMinimum: 0	Position
items_source_checklist_id	integer	minimum: 1	Checklist id to copy list items from
exclude_item_ids	array of integers		If source id is presented, these ids will be used to not include list items in created checklist
source_share_id	integer	minimum: 1	Share checklist id

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	Card checklist id
name	string	Checklist name
policy_id	null \| integer	Template checklist id
checklist_id	string	Card checklist id
sort_order	number	Position
deleted	boolean	Flag indicating that checklist deleted
items	array Schema	Checklist items

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.

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

card_id

Raw Body(json format)

  1  curl --request POST \
  2       --url 'https://example.kaiten.ru/api/latest/cards/{card_id}/checklists' \
  3       --header 'Accept: application/json' \
  4       --header 'Content-Type: application/json'
  5

Response

ClickTry It!to start a request and see the response here!