Update record
Updates record values and/or condition. Requires custom-properties management permission or settings.allow_editing=true. Omitted field IDs retain their values. Arrays replace the supplied field's value list. Required non-checkbox fields cannot be explicitly set to null or an empty string. Linked-directory reverse relations and display_value are updated automatically.
| Name | Type | Reference |
|---|---|---|
| directory_idrequired | string | Directory ID |
| record_idrequired | string | Record ID |
| Name | Value |
|---|---|
| Content-Type | application/json |
| Name | Type | Constraints | Description |
|---|---|---|---|
condition | enum | [active,inactive,removed] | Custom directory record condition |
values | object | Partial map keyed by active field UUIDs. Omitted fields remain unchanged. Use the same typed value objects as record creation (value_text, value_number, value_date, user_uid, select_value_uid, catalog_value_uid, directory_record_id); arrays replace a field's value list. null clears an optional single value. For multi-valued fields, use the desired replacement array; an empty array requests clearing. Required non-checkbox fields cannot be set to null or an empty string. |
| Name | Type | Constraints | Description |
|---|---|---|---|
| response_profile | string | none | summary | details | full | Default: full (also for unrecognized values). none returns only {id}; summary includes values and direct relations; details expands one linked-record level with its directory and fields; full additionally expands the next linked-record level. |
Responses
| Description | Response type | Example |
|---|---|---|
| Success | Object |
| 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 |
| Description | Response type | Example |
|---|---|---|
| Validation error | Object |
A schema has not been defined for this response code.
| Description | Response type | Example |
|---|---|---|
| Invalid token | String |
| Description | Response type | Example |
|---|---|---|
| Not found | Object |
A schema has not been defined for this response code.
Examples
Update only the specified record fields; other fields keep their values. Replace these example field IDs with IDs from your directory.
Change a name and clear an optional email
{
"values": {
"c1d2e3f4-1111-4aaa-8bbb-ccccdddd0001": {
"value_text": "Alice Smith"
},
"c1d2e3f4-1111-4aaa-8bbb-ccccdddd0002": null
}
}Deactivate a record without changing its values
{
"condition": "inactive"
}
Kaiten
If you have any questions or need help with integration feel free to write us at support@kaiten.ru
Path Parameters
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!