Help Center/KooDrive/API Reference（Carrier）/API/Shared Folder Management/Creating a Shared Folder
Updated on 2026-02-12 GMT+08:00
View PDF
Share

Creating a Shared Folder

Function

Create a shared folder.

URI

POST /koodrive/ose/v1/sharefolder/create

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Traceid

No

String

Definition:

Service trace ID, which contains 58 bits.

Constraints:

N/A

Range:

The value contains 58 bits.

Default Value:

N/A

language

No

String

Definition:

Language code.

Constraints:

The value must comply with the internationalization specifications. For example, en_us indicates English (United States).

Range:

The value must comply with the internationalization specifications.

Default Value:

en-US

X-User-Id

Yes

String

Definition:

User ID on KooDrive, which is used for app authentication.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Date

Yes

String

Definition:

Date, which is used for app authentication.

Constraints:

The format is yyyyMMDD'T'HHmmss'Z', for example, 20251103T070140Z.

Range:

The value must be within 15 minutes from the current time and cannot be later than the current time.

Default Value:

N/A

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

shareType

Yes

Integer

Definition:

Type of the created shared folder.

Constraints:

Currently, only family shared folders can be created.

Range:

0: family shared folder

Default Value:

N/A

containerId

Yes

String

Definition:

Personal space ID of the owner of the shared folder.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

name

Yes

String

Definition:

Name of the created shared folder.

Constraints:

The name length is less than 32.

Cannot contain emoji.

Cannot contain only one or two consecutive periods (. or ..).

The following characters are not allowed:

< > | : * ? " /

The following whitespace characters are not allowed:

\n \r \b \t

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

ID.

data

CreateShareFolderInfo object

Create a shared folder.

code

Integer

Response code.

msg

String

Response.

Table 4 CreateShareFolderInfo

Parameter

Type

Description

tenantId

String

Tenant ID.

creator

String

Creator.

createTime

String

Creation time.

groupId

Long

Group ID.

id

String

Primary key ID of the shared folder table.

shareFolderId

String

Shared folder file ID.

Example Requests

Create a family shared folder for testing. The container ID is IAAFanxbXNArpAncA1645841408025905537.

/koodrive/ose/v1/sharefolder/create

{
  "shareType" : 0,
  "containerId" : "IAAFanxbXNArpAncA1645841408025905537",
  "name" : "Test Creating a Shared Folder"
}

Example Responses

Status code: 200

Shared folder details.

{
  "id" : "1765148493107805441",
  "data" : {
    "tenantId" : "c937ff95eeb44494a5a967e21d1852ae",
    "creator" : "1644817543959100032",
    "createTime" : "2025-09-01T02:34:57.815Z",
    "groupId" : 1765148492881313000,
    "id" : "1765148493107805441",
    "shareFolderId" : "Fi94r66FoDTSP44M1VkJNup0JH-FIano0"
  },
  "code" : 0,
  "msg" : "Success."
}

Status Codes

Status Code

Description

200

Shared folder details.