Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Update record

PATCH

https://example.kaiten.ru/api/latest/company/custom-directories/{directory_id}/records/{record_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.

Updates record values and/or condition. Use `response_profile` query param to control the response size.

Path parameters

Name	Type	Reference
directory_idrequired	string	Directory ID
record_idrequired	string	Record 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",
    "removed"
   ],
   "description": "Custom directory record condition"
  },
  "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)."
  }
 }
}

Name	Type	Constraints	Description
condition	enum	[active,inactive,removed]	Custom directory record condition
values	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)
display_value	null \| string	Pre-computed record display value
values	array of objects	Field values (included depending on response_profile)
author	object	Author user object
updater	object	Updater user object

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

record_id

Raw Body(json format)

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