Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Update catalog value

PATCH

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

Path parameters

Name	Type	Reference
property_idrequired	integer	CustomProperty ID
idrequired	integer	CatalogValue ID

Headers

Name	Value
Content-Type	application/json

Attributes

schema

{
 "$schema": "http://json-schema.org/draft-06/schema",
 "type": "object",
 "properties": {
  "condition": {
   "enum": [
    "active",
    "inactive"
   ],
   "description": "Custom property catalog value condition"
  },
  "value": {
   "type": "object",
   "description": "Contains pairs key: value, where the key is the uid of the catalog field, the value - value of this field"
  },
  "deleted": {
   "type": "boolean",
   "description": "Custom property catalog value delete condition"
  }
 },
 "anyOf": [
  {
   "required": [
    "condition"
   ]
  },
  {
   "required": [
    "value"
   ]
  }
 ]
}

Name	Type	Constraints	Description
condition	enum	[active,inactive]	Custom property catalog value condition
value	object		Contains pairs key: value, where the key is the uid of the catalog field, the value - value of this field
deleted	boolean		Custom property catalog 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	Catalog option id
custom_property_id	integer	Custom property id
value	object Schema	Custom property catalog value
name	string	Custom property catalog value name
author_id	integer	Author id
updater_id	integer	Last updater id
condition	string	Custom property catalog value condition

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.

Examples

How to update

{
  "value": {
    "3889a0a5-66de-4df3-9bd6-405e02eecfca": "Updated value"
  }
}

get field_uids

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}/catalog-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!