latestOpenAPI 3.0.42026-08-10174362.4 KB

70fb92d278f5

References

Create a Personal Folder

Creates one or more personal (user-owned) reference folders. Each folder is owned by the specified UserId (access level 30 — Full). The owner is recorded automatically; it cannot be set via POST /references/folder/users.

Supports bulk creation: send an array with one or more items. A failure on one item does not affect others.

All responses use HTTP 200. Check each item's success field to determine the outcome. When success is false, the error field contains a description and folderId is null.

post/references/personalfolder

Request body

folderNamestring nullable

The name of the folder to create. Cannot contain double quotes, backslashes, angle brackets, or control characters.

userIdinteger

The user who will become the folder owner. Must be greater than zero.

Response

Folders created.

folderNamestring nullable

Echo of the folder name from the request. Used to correlate results in bulk operations.

folderIdstring nullable

The generated folder identifier (numeric or 32-character hex GUID). Null when Success is false.

successboolean

Indicates whether the folder was created successfully.

errorstring nullable

Error description when Success is false. Null when the operation succeeds.