Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Create record

POST

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

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 custom directory record. The request body uses a `values` map where keys are directory field IDs. Use `response_profile` query param to control the response size.

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": {
  "values": {
   "type": "object",
   "description": "Values map where keys are custom directory field IDs. Each value is either an object (single-value) or an array of objects (multi-select)."
  }
 },
 "required": [
  "values"
 ]
}

Name	Type	Constraints	Description
values required	object		Values map where keys are custom directory field IDs. Each value is either an object (single-value) or an array of objects (multi-select).

Query

Name	Type	Constraints	Description
response_profile	string	none \| summary \| details \| full	Controls response size. Use `none` to return `{ id }` only.

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
id	string	Record ID (UUID)
custom_directory_id	string	Directory ID (UUID)
display_value	null \| string	Pre-computed record display value
condition	enum	Record condition: active \| inactive \| removed
author_uid	string	Author user UID (UUID)
updater_uid	string	Updater user UID (UUID)
created	string	Create date
updated	string	Last update timestamp
author	object	Author user object
updater	object	Updater user object
values	array of objects Schema	Field values for the record

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.

Examples

Create custom directory record

{
  "values": {
    "c1d2e3f4-1111-4aaa-8bbb-ccccdddd0001": {
      "value_text": "Alice"
    },
    "c1d2e3f4-1111-4aaa-8bbb-ccccdddd0002": {
      "value_text": "alice@example.com"
    }
  }
}

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}/records' \
  3       --header 'Accept: application/json' \
  4       --header 'Content-Type: application/json'
  5

Response

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