Soft-deletes the directory (condition=removed). Deletion is not allowed if there are active custom properties linked to this directory.
| Name | Type | Reference |
|---|---|---|
| directory_idrequired | string | Directory ID |
| Name | Value |
|---|---|
| Content-Type | application/json |
| Description | Response type | Example |
|---|---|---|
| Success | Object |
| Name | Type | Description |
|---|---|---|
| id | string | Directory ID (UUID) |
| condition | enum | Directory condition: removed |
| Description | Response type | Example |
|---|---|---|
| Validation error | Object |
| Name | Type | Description |
|---|---|---|
| message | string | Error message |
| code | integer | Error code (customDirectoryErrorCodes) |
| Description | Response type | Example |
|---|---|---|
| Invalid token | String |
A schema has not been defined for this response code.
| Description | Response type | Example |
|---|---|---|
| Not found | Object |
A schema has not been defined for this response code.
Path Parameters
1 curl --request DELETE \
2 --url 'https://example.kaiten.ru/api/latest/company/custom-directories/{directory_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!