Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Create field

POST

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

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.

Creates a directory field. Note: advanced field bindings (custom_property_uid, linked_directory_id) are typically configured via directory create/update endpoints.

Path parameters

Name	Type	Reference
directory_idrequired	string	Directory 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"
  },
  "type": {
   "enum": [
    "string",
    "number",
    "date",
    "email",
    "url",
    "phone",
    "checkbox",
    "select",
    "user",
    "catalog",
    "directory_link",
    "file"
   ],
   "description": "Field type"
  },
  "sort_order": {
   "type": "integer",
   "minimum": 0,
   "description": "Field position"
  },
  "required": {
   "type": "boolean",
   "default": false,
   "description": "Required field flag"
  },
  "is_display": {
   "type": "boolean",
   "default": false,
   "description": "Display field flag"
  }
 },
 "required": [
  "name",
  "type"
 ]
}

Name	Type	Constraints	Description
name required	string	minLength: 1 maxLength: 256	Field name
type required	enum	[ string, number, date, email, url, phone, checkbox, select, user, catalog, directory_link, file ]	Field type
sort_order	integer	minimum: 0	Field position
required	boolean default:false		Required field flag
is_display	boolean default:false		Display field flag

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
id	string	Field ID (UUID)
custom_directory_id	string	Directory ID (UUID)
name	string	Field name
type	enum	Field type: string \| number \| date \| email \| url \| phone \| checkbox \| select \| user \| catalog \| directory_link \| file
required	boolean	Required flag
is_display	boolean	Display field flag
sort_order	integer	Field position
condition	enum	Field condition: active \| inactive \| removed
created	string	Create date
updated	string	Last update timestamp

400

Description	Response type	Example
Validation error	Object	Open

A schema has not been defined for this response code.

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

Raw Body(json format)

  1  curl --request POST \
  2       --url 'https://example.kaiten.ru/api/latest/company/custom-directories/{directory_id}/fields' \
  3       --header 'Accept: application/json' \
  4       --header 'Content-Type: application/json'
  5

Response

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