Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Batch update for cards

PATCH

https://example.kaiten.ru/api/latest/cards

Update multiple cards by criteria. Runs in the background and returns a job ID.

Headers

Name	Value
Content-Type	application/json

Attributes

schema

{
 "$schema": "http://json-schema.org/draft-06/schema",
 "type": "object",
 "properties": {
  "board_id": {
   "type": "integer",
   "description": "Сriteria board ID"
  },
  "column_id": {
   "type": "integer",
   "description": "Criteria column ID"
  },
  "lane_id": {
   "type": "integer",
   "description": "Criteria lane ID"
  },
  "owner_id": {
   "type": "integer",
   "description": "Criteria owner ID"
  },
  "type_id": {
   "type": "integer",
   "description": "Criteria card type ID"
  },
  "condition": {
   "enum": [
    1,
    2
   ],
   "description": "Criteria conditions: 1 - live, 2 - archived"
  },
  "attributes": {
   "type": "object",
   "description": "attributes to change",
   "properties": {
    "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"
    },
    "condition": {
     "enum": [
      1,
      2
     ],
     "description": "1 - live, 2 - archived"
    },
    "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"
      }
     ]
    },
    "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"
    },
    "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"
      }
     ]
    }
   },
   "anyOf": [
    {
     "required": [
      "board_id"
     ]
    },
    {
     "required": [
      "column_id"
     ]
    },
    {
     "required": [
      "lane_id"
     ]
    },
    {
     "required": [
      "owner_id"
     ]
    },
    {
     "required": [
      "type_id"
     ]
    },
    {
     "required": [
      "condition"
     ]
    }
   ]
  },
  "order_by": {
   "type": "object",
   "description": "Sorting parameters",
   "properties": {
    "field_type": {
     "enum": [
      "cp",
      "size",
      "created",
      "due_date",
      "title"
     ],
     "description": "Field type to sort by"
    },
    "id": {
     "type": "integer",
     "description": "Field id to sort by"
    },
    "direction": {
     "enum": [
      "asc",
      "desc"
     ],
     "description": "Sorting direction"
    }
   },
   "anyOf": [
    {
     "required": [
      "field_type",
      "direction"
     ]
    }
   ]
  }
 },
 "anyOf": [
  {
   "required": [
    "board_id",
    "attributes"
   ]
  },
  {
   "required": [
    "column_id",
    "attributes"
   ]
  },
  {
   "required": [
    "lane_id",
    "attributes"
   ]
  },
  {
   "required": [
    "owner_id",
    "attributes"
   ]
  },
  {
   "required": [
    "type_id",
    "attributes"
   ]
  },
  {
   "required": [
    "condition",
    "attributes"
   ]
  },
  {
   "required": [
    "column_id",
    "lane_id",
    "order_by"
   ]
  }
 ]
}

Name	Type	Constraints	Description
board_id	integer		Сriteria board ID
column_id	integer		Criteria column ID
lane_id	integer		Criteria lane ID
owner_id	integer		Criteria owner ID
type_id	integer		Criteria card type ID
condition	enum	[1,2]	Criteria conditions: 1 - live, 2 - archived
attributes	object Schema		attributes to change
order_by	object Schema		Sorting parameters

Responses

202

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
id	string	Unique identifier (UUID) of the background job

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

Raw Body(json format)

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

Response

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