Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Update field

PATCH

https://example.kaiten.ru/api/latest/company/custom-directories/{directory_id}/fields/{field_id}

This endpoint is currently under active development. Parameters, attributes, and response formats are subject to change. Custom directories API is in beta and may change.

Path parameters

Name	Type	Reference
directory_idrequired	string	Directory ID
field_idrequired	string	Field ID

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": 256,
   "description": "Field name"
  },
  "condition": {
   "enum": [
    "active",
    "inactive",
    "removed"
   ],
   "description": "Custom directory field condition"
  },
  "sort_order": {
   "type": "integer",
   "minimum": 0,
   "description": "Field position"
  },
  "required": {
   "type": "boolean",
   "description": "Required field flag"
  },
  "is_display": {
   "type": "boolean",
   "description": "Display field flag"
  }
 }
}

Name	Type	Constraints	Description
name	string	minLength: 1 maxLength: 256	Field name
condition	enum	[active,inactive,removed]	Custom directory field condition
sort_order	integer	minimum: 0	Field position
required	boolean		Required field flag
is_display	boolean		Display field flag

Responses

200

401

404

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
id	string	Field ID (UUID)
name	string	Field name
required	boolean	Required flag
is_display	boolean	Display field flag
sort_order	integer	Field position
condition	enum	Field condition: active \| inactive \| removed

401

Description	Response type	Example
Invalid token	String	Open

A schema has not been defined for this response code.

404

Description	Response type	Example
Not found	Object	Open

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

directory_id

field_id

Raw Body(json format)

  1  curl --request PATCH \
  2       --url 'https://example.kaiten.ru/api/latest/company/custom-directories/{directory_id}/fields/{field_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!