Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Update select value

PATCH

https://example.kaiten.ru/api/latest/company/custom-properties/{property_id}/select-values/{id}

Path parameters

Name	Type	Reference
property_idrequired	integer	CustomProperty ID
idrequired	integer	Select Value ID

Headers

Name	Value
Content-Type	application/json

Attributes

schema

{
 "$schema": "http://json-schema.org/draft-06/schema",
 "type": "object",
 "properties": {
  "value": {
   "type": "string",
   "minLength": 1,
   "maxLength": 128,
   "description": "Custom property select value"
  },
  "color": {
   "oneOf": [
    {
     "type": [
      "integer"
     ],
     "description": "Color of custom property select value"
    },
    {
     "type": "null",
     "description": "Custom property select value without color"
    }
   ]
  },
  "condition": {
   "enum": [
    "active",
    "inactive"
   ],
   "description": "Custom property select value condition"
  },
  "sort_order": {
   "type": "number",
   "minimum": 0
  },
  "deleted": {
   "type": "boolean",
   "description": "Custom property select value delete condition"
  }
 },
 "anyOf": [
  {
   "required": [
    "value"
   ]
  },
  {
   "required": [
    "color"
   ]
  },
  {
   "required": [
    "deleted"
   ]
  },
  {
   "required": [
    "sort_order"
   ]
  },
  {
   "required": [
    "condition"
   ]
  }
 ]
}

Name	Type	Constraints	Description
value	string	minLength: 1 maxLength: 128	Custom property select value
color	integer		Color of custom property select value
color	null		Custom property select value without color
condition	enum	[active,inactive]	Custom property select value condition
sort_order	number	minimum: 0
deleted	boolean		Custom property select value delete condition

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	Select option id
custom_property_id	integer	Custom property id
value	string	Select option value
color	integer	Color number
author_id	integer	Author id
company_id	integer	Company id
condition	string	Custom property select value condition
sort_order	number	Position
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.

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	Object	Open

Response Attributes

Name	Type	Description
message	string	Error message

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

property_id

Raw Body(json format)

  1  curl --request PATCH \
  2       --url 'https://example.kaiten.ru/api/latest/company/custom-properties/{property_id}/select-values/{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!