> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Rename a file or folder

> Call this API to rename a file or folder in DingTalk Drive. The root directory of the storage space cannot be renamed.

Call this API to rename a file or folder. The root directory of a storage space cannot be renamed.

## Request

### Basic information

| Field                | Value                                                                              |
| -------------------- | ---------------------------------------------------------------------------------- |
| HTTP URL             | `https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{dentryId}/rename` |
| HTTP Method          | POST                                                                               |
| Supported app types  | appType-Internal app　appType-Third-party enterprise app                            |
| Required permissions | permission-Storage.File.Write-Organization storage file write permission           |

### Request header

| Name                        | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| --------------------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| x-acs-dingtalk-access-token | String | Yes      | The access credential used to call this API. Obtain it as follows:   - For an internal app, call the [Get the access token of an internal app](/open/development/obtain-the-access-token-of-an-internal-app) API. - For a third-party enterprise app, call the [Get the access token of the authorized organization for a third-party app](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1) API. |

### Path parameter

| Name     | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                        |
| -------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| spaceId  | String | Yes      | The space ID. Call the [Add a space](/open/development/add-space) API to obtain the value of the `id` parameter.                                                                                                                                                                                                                                                   |
| dentryId | String | Yes      | The file or folder ID. Call the [Get the list of files or folders](/open/development/get-a-list-of-files-or-folders) or [Get spaceId and dentryId by dentryUuid](/open/development/api-getdentryidbyuuid) API to obtain the value of the `id` parameter.  The root directory of a storage space cannot be renamed, so this parameter does not support the value 0. |

### Query parameter

| Name    | Type   | Required | Description                                                                                                                                          |
| ------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| unionId | String | Yes      | The unionId of the operator. Call the [Query user details](/open/development/query-user-details) API to obtain the value of the `unionid` parameter. |

### Request body

| Name    | Type   | Required | Description                                                                                                                                                                           |                            |
| ------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
| newName | String | Yes      | The new name of the file or folder. Naming rules:- Leading and trailing spaces are automatically removed. - Cannot contain special characters, including: tab, `*`, `"`, `<`, `>`, \` | `. - Cannot end with `.\`. |

### Request example

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v1.0/storage/spaces/854xxxxx/dentries/645xxxxx/rename?unionId=cHtUYxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "newName" : "Test"
}
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using the Token</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkstorage_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkstorage_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkstorage_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkstorage_1_0.models.RenameDentryHeaders renameDentryHeaders = new com.aliyun.dingtalkstorage_1_0.models.RenameDentryHeaders();
        renameDentryHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.RenameDentryRequest renameDentryRequest = new com.aliyun.dingtalkstorage_1_0.models.RenameDentryRequest()
                .setUnionId("cHtUYxxxxx")
                .setNewName("Test");
        try {
            client.renameDentryWithOptions("854xxxxx", "645xxxxx", renameDentryRequest, renameDentryHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains the code and message attributes, which help locate the issue
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains the code and message attributes, which help locate the issue
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

from typing import List

from alibabacloud_dingtalk.storage_1_0.client import Client as dingtalkstorage_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.storage_1_0 import models as dingtalkstorage__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkstorage_1_0Client:
        """
        Initialize the account Client using the Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkstorage_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        rename_dentry_headers = dingtalkstorage__1__0_models.RenameDentryHeaders()
        rename_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        rename_dentry_request = dingtalkstorage__1__0_models.RenameDentryRequest(
            union_id='cHtUYxxxxx',
            new_name='Test'
        )
        try:
            client.rename_dentry_with_options('854xxxxx', '645xxxxx', rename_dentry_request, rename_dentry_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        rename_dentry_headers = dingtalkstorage__1__0_models.RenameDentryHeaders()
        rename_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        rename_dentry_request = dingtalkstorage__1__0_models.RenameDentryRequest(
            union_id='cHtUYxxxxx',
            new_name='Test'
        )
        try:
            await client.rename_dentry_with_options_async('854xxxxx', '645xxxxx', rename_dentry_request, rename_dentry_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which help locate the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
```

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\RenameDentryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\RenameDentryRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using the Token
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $renameDentryHeaders = new RenameDentryHeaders([]);
        $renameDentryHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $renameDentryRequest = new RenameDentryRequest([
            "unionId" => "cHtUYxxxxx",
            "newName" => "Test"
        ]);
        try {
            $client->renameDentryWithOptions("854xxxxx", "645xxxxx", $renameDentryRequest, $renameDentryHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err contains the code and message attributes, which help locate the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
```

Go

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkstorage_1_0  "github.com/alibabacloud-go/dingtalk/storage_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Initialize the account Client using the Token
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkstorage_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkstorage_1_0.Client{}
  _result, _err = dingtalkstorage_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  renameDentryHeaders := &dingtalkstorage_1_0.RenameDentryHeaders{}
  renameDentryHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  renameDentryRequest := &dingtalkstorage_1_0.RenameDentryRequest{
    UnionId: tea.String("cHtUYxxxxx"),
    NewName: tea.String("Test"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.RenameDentryWithOptions(tea.String("854xxxxx"), tea.String("645xxxxx"), renameDentryRequest, renameDentryHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err contains the code and message attributes, which help locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
```

Node.js

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkstorage_1_0 = require('@alicloud/dingtalk/storage_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Initialize the account Client using the Token
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkstorage_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let renameDentryHeaders = new dingtalkstorage_1_0.RenameDentryHeaders({ });
    renameDentryHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let renameDentryRequest = new dingtalkstorage_1_0.RenameDentryRequest({
      unionId: 'cHtUYxxxxx',
      newName: 'Test',
    });
    try {
      await client.renameDentryWithOptions('854xxxxx', '645xxxxx', renameDentryRequest, renameDentryHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message attributes, which help locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
```

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
using Newtonsoft.Json;
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Initialize the account Client using the Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkstorage_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkstorage_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RenameDentryHeaders renameDentryHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RenameDentryHeaders();
            renameDentryHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RenameDentryRequest renameDentryRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RenameDentryRequest
            {
                UnionId = "cHtUYxxxxx",
                NewName = "Test",
            };
            try
            {
                client.RenameDentryWithOptions("854xxxxx", "645xxxxx", renameDentryRequest, renameDentryHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message attributes, which help locate the issue
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message attributes, which help locate the issue
                }
            }
        }

    }
}
```

## Response

### Response body

| Name          | Type                 | Description                                                                                                                                               |
| ------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| dentry        | Object               | The list of file or folder information.                                                                                                                   |
| id            | String               | The file or folder ID.                                                                                                                                    |
| spaceId       | String               | The ID of the space that the file or folder belongs to.                                                                                                   |
| parentId      | String               | The parent directory ID. For the root directory, this parameter is 0.                                                                                     |
| type          | String               | The type:   - **FILE**: file - **FOLDER**: folder                                                                                                         |
| name          | String               | The name after renaming.                                                                                                                                  |
| size          | Long                 | The file size, in bytes.  This field is not returned for folders.                                                                                         |
| path          | String               | The path of the file or folder.                                                                                                                           |
| version       | Long                 | The version.                                                                                                                                              |
| status        | String               | The status:   - **NORMAL**: normal - **DELETED**: deleted - **EXPIRED**: expired                                                                          |
| extension     | String               | The file extension.  This field is not returned for folders.                                                                                              |
| creatorId     | String               | The unionId of the creator.                                                                                                                               |
| modifierId    | String               | The unionId of the modifier.                                                                                                                              |
| createTime    | String               | The created time, in ISO 8601 format. Example: 2022-07-29T14:55Z.                                                                                         |
| modifiedTime  | String               | The modified time, in ISO 8601 format. Example: 2022-07-29T14:55Z.                                                                                        |
| properties    | Object               | The attributes.                                                                                                                                           |
| readOnly      | Boolean              | Whether the file or folder is read-only:   - **true**: yes - **false**: no                                                                                |
| appProperties | `Map<String, Array>` | The attributes specific to an app.                                                                                                                        |
|               | Array                | The list of attributes.                                                                                                                                   |
| name          | String               | The attribute name.                                                                                                                                       |
| value         | String               | The attribute value.                                                                                                                                      |
| visibility    | String               | The attribute visibility:   - **PUBLIC**: visible to all spaces - **PTIVATE**: visible only to the current space                                          |
| uuid          | String               | The identifier field.                                                                                                                                     |
| partitionType | String               | The storage partition:   - **PUBLIC\_OSS\_PARTITION**: public cloud OSS storage partition - **MINI\_OSS\_PARTITION**: dedicated MiniOSS storage partition |
| storageDriver | String               | The driver type:   - **DINGTALK**: DingTalk unified storage driver - **ALIDOC**: DingTalk Docs storage driver - **UNKNOWN**: unknown driver               |

### Response body example

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "dentry" : {
    "id" : "645xxxxx",
    "spaceId" : "854xxxxx",
    "parentId" : "0",
    "type" : "FILE",
    "name" : "Test",
    "size" : 512,
    "path" : "/TestFolder",
    "version" : 1,
    "status" : "NORMAL",
    "extension" : "txt",
    "creatorId" : "cHtUYxxxxx",
    "modifierId" : "cHtUYxxxxx",
    "createTime" : "2022-01-01T10:00:00Z",
    "modifiedTime" : "2022-01-01T10:00:00Z",
    "properties" : {
      "readOnly" : true
    },
    "appProperties" : [ {
      "name" : "Attribute1",
      "value" : "AttributeValue1",
      "visibility" : "PRIVATE"
    } ],
    "uuid" : "uuid",
    "partitionType" : "PUBLIC_OSS_PARTITION",
    "storageDriver" : "DINGTALK"
  }
}
```

### Error codes

If the API call fails, refer to the error message and look up the solution in the [Global error codes](/open/development/server-api-error-codes-1) document.

| HttpCode | Error code                 | Error message | Description                                            |
| -------- | -------------------------- | ------------- | ------------------------------------------------------ |
| 400      | operationConcurrentControl | %s            | Concurrency control                                    |
| 400      | paramError                 | %s            | Parameter error                                        |
| 400      | paramError.spaceId         | %s            | Parameter error - spaceId                              |
| 400      | paramError.dentryId        | %s            | Parameter error - dentryId                             |
| 400      | paramError.name            | %s            | Parameter error - name                                 |
| 400      | dentryAlreadyExist         | %s            | A file with the same name already exists               |
| 403      | permissionDenied           | %s            | The user lacks permission to rename the file or folder |
| 404      | spaceNotExist              | %s            | The space does not exist                               |
| 404      | dentryNotExist             | %s            | The file does not exist                                |
| 500      | systemError                | %s            | System error                                           |
| 500      | unknownError               | Unknown Error | Unknown error                                          |
| 503      | operationTimeout           | %s            | Request timed out                                      |