Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Update space

PATCH

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

Path parameters

Name	Type	Reference
space_idrequired	integer	Space 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": 256,
     "description": "Space title"
    },
    {
     "type": "number"
    }
   ]
  },
  "external_id": {
   "oneOf": [
    {
     "type": [
      "number",
      "string"
     ],
     "maxLength": 1024,
     "description": "Any external id you want to assign to space. Not exposed in web interface"
    },
    {
     "type": "null",
     "description": "Any external id you want to assign to space. Not exposed in web interface"
    }
   ]
  },
  "hidden_card_type_uids": {
   "type": "array",
   "items": {
    "type": "string",
    "format": "uuid"
   },
   "description": "List of hidden card type uids."
  },
  "settings": {
   "type": "object"
  },
  "access": {
   "enum": [
    "for_everyone",
    "by_invite"
   ]
  },
  "parent_entity_uid": {
   "type": [
    "string",
    "null"
   ],
   "description": "Parent tree entity uid"
  },
  "sort_order": {
   "type": "number",
   "minimum": 0,
   "exclusiveMinimum": 0
  }
 },
 "anyOf": [
  {
   "required": [
    "title"
   ]
  },
  {
   "required": [
    "external_id"
   ]
  },
  {
   "required": [
    "hidden_card_type_uids"
   ]
  }
 ]
}

Name	Type	Constraints	Description
title	string	minLength: 1 maxLength: 256	Space title
title	number
external_id	number \| string \| null		Any external id you want to assign to space. Not exposed in web interface
hidden_card_type_uids	array of strings		List of hidden card type uids.
settings	object
access	enum	[for_everyone,by_invite]
parent_entity_uid	string \| null		Parent tree entity uid
sort_order	number	minimum: 0 exclusiveMinimum: 0

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
id	integer	Space id
uid	string	Space uid
title	string	Space title
updated	string	Last update timestamp
created	string	Create date
archived	boolean	Space archived flag
access	string	Space access
for_everyone_access_role_id	string	Role id for everyone access
entity_type	string	Entity type
path	string	Inner path to entity
sort_order	number	Space sort order
parent_entity_uid	null \| string	Parent entity uid
company_id	integer	Company id
allowed_card_type_idsDeprecated: use hidden_card_type_uids instead	null \| array	Allowed card types for this space
hidden_card_type_uids	null \| array	List of hidden card type uids
external_id	null \| string	External id
settings	null \| object	Space settings

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
Forbiden		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}' \
  3       --header 'Accept: application/json' \
  4       --header 'Content-Type: application/json'
  5

Response

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