Updated on 2026-02-12 GMT+08:00

Updating an Album

Function

Update an album. For collection albums, update the scope and type; for manual albums, update the name. coverImageUrl is a reserved field. Currently, the cover of a manual album is the thumbnail of the first image. The album does not need a cover.

URI

POST /koodrive/ose/v1/{albumId}/update

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

albumId

Yes

String

Definition:

Album ID.

Constraints:

Use the ID returned after an album is created.

Range:

N/A

Default Value:

N/A

Request Parameters

Table 2 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

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

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

language

No

String

Definition:

Language code.

Constraints:

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

Range:

N/A

Default Value

If this parameter is not transferred, English (United States) is used by default.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

scopeParentFolderId

No

String

Definition:

Parent directory ID of the collection scope.

Constraints:

The collection scope must be a level-1 directory. Therefore, there is only one parent directory ID.

Range:

N/A

Default Value:

N/A

scopeDirList

No

Array of strings

Definition:

Collection scope ID list.

Constraints:

The collection scope must be a level-1 directory.

Range:

The maximum list length is 30.

Default Value:

N/A

scopeKind

No

Integer

Definition:

Collection type.

Constraints:

N/A

Range:

1: image 2: video Example: 1,2.

Default Value:

N/A

name

No

String

Definition:

Album name.

Constraints:

N/A

Range:

A string of 1 to 20 characters

Default Value:

N/A

coverImageUrl

No

String

Definition:

Cover image URL.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

Integer

Response code.

msg

String

Response.

Example Requests

Rename an album.

/koodrive/ose/v1/{albumId}/update

{
  "name" : "albumName22"
}

Example Responses

Status code: 200

Response for updating an album.

{
  "code" : 0,
  "msg" : "Success."
}

Status Codes

Status Code

Description

200

Response for updating an album.