Update a folder with ID

Updated on Jun 2, 2025

3 minute(s) read

Anand Murali

Prev Next

Put

/v2/Drive/Folders

Security

API Key: api_token

Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Query parameters

folderId

stringRequired

The ID of drive folder

Body parameters

Update media folder

Request body for updating folder with name,order,folder color and IsStarred.

{
  "name": "Updated folder name",
  "order": 2,
  "folder_color": "#8852F5",
  "is_starred": true
}

object

name

string | null

The new name for the folder being updated

order

integer (int32) | null

The order of the folder

folder_color

string | null

The color of the folder - should be in hexadecimal color code format

Pattern^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

is_starred

boolean

To update the folder as starred

Update media folder

Request body for updating folder with name,order,folder color and IsStarred.

{
  "name": "Updated folder name",
  "order": 2,
  "folder_color": "#8852F5",
  "is_starred": true
}

object

name

string | null

The new name for the folder being updated

order

integer (int32) | null

The order of the folder

folder_color

string | null

The color of the folder - should be in hexadecimal color code format

Pattern^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

is_starred

boolean

To update the folder as starred

Update media folder

Request body for updating folder with name,order,folder color and IsStarred.

{
  "name": "Updated folder name",
  "order": 2,
  "folder_color": "#8852F5",
  "is_starred": true
}

object

name

string | null

The new name for the folder being updated

order

integer (int32) | null

The order of the folder

folder_color

string | null

The color of the folder - should be in hexadecimal color code format

Pattern^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

is_starred

boolean

To update the folder as starred

Update media folder

Request body for updating folder with name,order,folder color and IsStarred.

{
  "name": "Updated folder name",
  "order": 2,
  "folder_color": "#8852F5",
  "is_starred": true
}

object

name

string | null

The new name for the folder being updated

order

integer (int32) | null

The order of the folder

folder_color

string | null

The color of the folder - should be in hexadecimal color code format

Pattern^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

is_starred

boolean

To update the folder as starred

Responses

200

Success

Bad Response

This response indicates the folder has been updated successfully.

{
  "data": {
    "media_folder_id": "d79c041c-0f94-4b04-a8b6-a14bb1995eca",
    "media_folder_title": "Folder Title",
    "order": 1,
    "icon": null,
    "updated_on": "2024-06-13T14:30:00Z",
    "folder_color": null,
    "is_starred": true,
    "updated_by": "fdsc041c-0f94-4b04-a8b6-a14bb1995eca",
    "parent_media_folder_id": null
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

data

object | null

Media folder response meta data

media_folder_id

string | null

The folder ID

media_folder_title

string | null

The folder title

order

integer (int32)

The folder order

icon

string | null

The folder icon

updated_on

string (date-time)

The date the file was modified

folder_color

string | null

The folder color

is_starred

boolean

This denotes the file is starred or not

updated_by

string | null

The ID of the user who uploaded the folder

parent_media_folder_id

string | null

The parent folder ID

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

400

Bad Request

Bad Response

Kindly verify the folder ID and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

Was this article helpful?