Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Create new property

POST

https://example.kaiten.ru/api/latest/company/custom-properties

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": 128,
   "description": "Custom property name"
  },
  "show_on_facade": {
   "type": "boolean",
   "description": "Should show property on card's facade",
   "default": false
  },
  "multiline": {
   "type": "boolean",
   "description": "Should render multiline text field",
   "default": false
  },
  "vote_variant": {
   "oneOf": [
    {
     "type": "null",
     "description": "Empty vote variant - for custom properties not of type vote and collective vote"
    },
    {
     "enum": [
      "rating",
      "scale",
      "emoji_set"
     ],
     "description": "Type of vote or collective vote custom properties"
    }
   ]
  },
  "type": {
   "enum": [
    "string",
    "number",
    "date",
    "email",
    "phone",
    "checkbox",
    "select",
    "formula",
    "url",
    "collective_score",
    "vote",
    "collective_vote",
    "catalog",
    "user",
    "attachment"
   ],
   "default": "string",
   "description": "Validation for value by provided type"
  },
  "values_type": {
   "oneOf": [
    {
     "type": "null",
     "description": "Empty for any type except collective value"
    },
    {
     "enum": [
      "number",
      "text"
     ],
     "description": "Type of values"
    }
   ]
  },
  "colorful": {
   "oneOf": [
    {
     "type": [
      "boolean"
     ],
     "description": "Used for select properties. Determines should select color when creating new select value."
    },
    {
     "type": "null",
     "description": "Empty colorful value"
    }
   ]
  },
  "multi_select": {
   "oneOf": [
    {
     "type": [
      "boolean"
     ],
     "description": "Used for select properties. Determines is select property used as multi select"
    },
    {
     "type": "null",
     "description": "Empty multi select value"
    }
   ]
  },
  "values_creatable_by_users": {
   "oneOf": [
    {
     "type": [
      "boolean"
     ],
     "description": "Used for select properties. Determines if users with writer role are able to create new select property values."
    },
    {
     "type": "null",
     "description": "Empty values_creatable_by_users value"
    }
   ]
  },
  "data": {
   "type": "object",
   "properties": {
    "restrictions": {
     "type": "object",
     "properties": {
      "min": {
       "oneOf": [
        {
         "type": "number",
         "description": "Minimum allowed on input value"
        },
        {
         "type": "null",
         "description": "Empty minimum value"
        }
       ]
      },
      "max": {
       "oneOf": [
        {
         "type": "number",
         "description": "Maximum allowed on input value"
        },
        {
         "type": "null",
         "description": "Empty maximum value"
        }
       ]
      },
      "minLength": {
       "oneOf": [
        {
         "type": "number",
         "minimum": 1,
         "description": "Minimum length allowed on input value"
        },
        {
         "type": "null",
         "description": "Empty minimum length"
        }
       ]
      },
      "maxLength": {
       "oneOf": [
        {
         "type": "number",
         "minimum": 1,
         "description": "Minimum length allowed on input value"
        },
        {
         "type": "null",
         "description": "Empty maximum length"
        }
       ]
      },
      "maxFilesCount": {
       "oneOf": [
        {
         "type": "number",
         "description": "Maximum allowed files count"
        },
        {
         "type": "null",
         "description": "Empty maximum value"
        }
       ]
      },
      "filesExtensions": {
       "oneOf": [
        {
         "type": "string",
         "description": "Allowed files extensions"
        },
        {
         "type": "null",
         "description": "Empty maximum value"
        }
       ]
      }
     },
     "anyOf": [
      {
       "required": [
        "min"
       ]
      },
      {
       "required": [
        "max"
       ]
      },
      {
       "required": [
        "minLength"
       ]
      },
      {
       "required": [
        "maxLength"
       ]
      },
      {
       "required": [
        "maxFilesCount"
       ]
      },
      {
       "required": [
        "filesExtensions"
       ]
      }
     ],
     "description": "Restrictions on input values"
    },
    "formula": {
     "type": "string",
     "description": "Formula content",
     "minLength": 1
    },
    "emoji": {
     "type": "string",
     "description": "Emoji for vote property of variant rating",
     "minLength": 1
    },
    "count": {
     "type": "integer",
     "description": "Count of emojis for vote property",
     "minimum": 2,
     "maximum": 10
    },
    "emojis": {
     "type": "array",
     "description": "List of emojis for vote property of variant emoji_set",
     "items": {
      "type": "string",
      "minLength": 1
     }
    },
    "min": {
     "type": "integer",
     "description": "Min value for vote property of variant scale"
    },
    "max": {
     "type": "integer",
     "description": "Max value for vote property of variant scale"
    },
    "calculation_method": {
     "enum": [
      "average",
      "sum"
     ],
     "description": "Calculation method for vote property of variant scale"
    }
   },
   "anyOf": [
    {
     "required": [
      "restrictions"
     ]
    },
    {
     "required": [
      "formula"
     ]
    },
    {
     "required": [
      "emoji",
      "count"
     ]
    },
    {
     "required": [
      "emojis"
     ]
    },
    {
     "required": [
      "min",
      "max",
      "calculation_method"
     ]
    }
   ]
  },
  "formula": {
   "type": "string",
   "description": "Formula for calculation"
  },
  "formula_source_card": {
   "type": "object",
   "description": "Card data from which are used to calculate the formula"
  },
  "color": {
   "oneOf": [
    {
     "type": [
      "integer"
     ],
     "description": "Color of catalog custom property"
    },
    {
     "type": "null",
     "description": "Catalog custom property without color"
    }
   ]
  },
  "fields_settings": {
   "type": "object",
   "minProperties": 1,
   "additionalProperties": false,
   "patternProperties": {
    "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$": {
     "type": "object",
     "properties": {
      "name": {
       "type": "string",
       "description": "Field name",
       "minLength": 1
      },
      "required": {
       "type": "boolean",
       "description": "Determines is field is required"
      },
      "deleted": {
       "type": "boolean",
       "description": "Determines is field is deleted",
       "default": false
      },
      "sortOrder": {
       "type": "number",
       "minimum": 1,
       "description": "Minimum sort order of field"
      }
     },
     "additionalProperties": false
    }
   }
  }
 },
 "anyOf": [
  {
   "required": [
    "name",
    "type"
   ]
  },
  {
   "required": [
    "formula",
    "formula_source_card"
   ]
  }
 ]
}

Name	Type	Constraints	Description
name	string	minLength: 1 maxLength: 128	Custom property name
show_on_facade	boolean default:false		Should show property on card's facade
multiline	boolean default:false		Should render multiline text field
vote_variant	null		Empty vote variant - for custom properties not of type vote and collective vote
vote_variant	enum	[rating,scale,emoji_set]	Type of vote or collective vote custom properties
type	enum default:string	[ string, number, date, email, phone, checkbox, select, formula, url, collective_score, vote, collective_vote, catalog, user, attachment ]	Validation for value by provided type
values_type	null		Empty for any type except collective value
values_type	enum	[number,text]	Type of values
colorful	boolean		Used for select properties. Determines should select color when creating new select value.
colorful	null		Empty colorful value
multi_select	boolean		Used for select properties. Determines is select property used as multi select
multi_select	null		Empty multi select value
values_creatable_by_users	boolean		Used for select properties. Determines if users with writer role are able to create new select property values.
values_creatable_by_users	null		Empty values_creatable_by_users value
data	object Schema
formula	string		Formula for calculation
formula_source_card	object		Card data from which are used to calculate the formula
color	integer		Color of catalog custom property
color	null		Catalog custom property without color
fields_settings	object Schema

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
name	string	Custom property name
type	string	Custom property type
show_on_facade	string	Should show property on card's facade
multiline	string	Should render multiline text field
fields_settings	null \| object Schema	Field settings for catalog type
author_id	integer	Author_id
company_id	integer	Company_id
updated	string	Last update timestamp
created	string	Create date
id	integer	Custom property id
condition	string	Custom property condition
colorful	boolean	Used for select properties. Determines should select color when creating new select value.
multi_select	boolean	Used for select properties. Determines is select property used as multi select
values_creatable_by_users	boolean	Used for select properties. Determines if users with writer role are able to create new select property values.
data	null \| object	Additional custom property data
values_type	null \| string	Type of values
vote_variant	null \| string	Type of vote or collective vote custom properties
protected	boolean	Protected flag
color	null \| integer	Color of catalog custom property
external_id	null \| string	External id

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.

Examples

How to create type

String

{
  "name": "string prop",
  "type": "string",
  "show_on_facade": false,
  "multiline": true
}

Url

{
  "name": "linkprop",
  "type": "url",
  "show_on_facade": true
}

Email

{
  "name": "email prop",
  "type": "email",
  "show_on_facade": true
}

Phone

{
  "name": "phone prop",
  "type": "phone",
  "show_on_facade": true
}

Select

{
  "name": "select prop",
  "type": "select",
  "show_on_facade": true,
  "multi_select": false,
  "colorful": true,
  "values_creatable_by_users": true
}

Multi select

{
  "name": "multi select prop",
  "type": "select",
  "show_on_facade": true,
  "multi_select": true,
  "colorful": true,
  "values_creatable_by_users": true
}

Number

{
  "name": "number prop",
  "type": "number",
  "show_on_facade": true
}

Formula

{
  "name": "formula prop",
  "type": "formula",
  "show_on_facade": false,
  "data": {
    "formula": "prop(\"Prop name\") * prop(\"goals_done\") - 1/2"
  }
}

Collective value

{
  "name": "collective value prop",
  "type": "collective_score",
  "show_on_facade": false,
  "values_type": "text"
}

Date

{
  "name": "date prop",
  "type": "date",
  "show_on_facade": true
}

Catalog

{
  "name": "catalog prop",
  "type": "catalog",
  "show_on_facade": true,
  "fields_settings": {
    "3889a0a5-66de-4df3-9bd6-405e02eecfca": {
      "name": "test",
      "required": true,
      "deleted": false,
      "sortOrder": 1
    }
  },
  "multiline": false,
  "color": 3
}

Collective rating

{
  "name": "collective rating",
  "type": "collective_vote",
  "show_on_facade": true,
  "data": {
    "emoji": "⭐️",
    "count": 5
  },
  "vote_variant": "rating"
}

Collective emoji set

{
  "name": "collective emoji set",
  "type": "collective_vote",
  "show_on_facade": true,
  "multiline": false,
  "data": {
    "emojis": [
      "😄",
      "🤪"
    ]
  },
  "vote_variant": "emoji_set"
}

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 POST \
  2       --url 'https://example.kaiten.ru/api/latest/company/custom-properties' \
  3       --header 'Accept: application/json' \
  4       --header 'Content-Type: application/json'
  5

Response

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