> ## 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.

# Create a worksheet

> Call this API to create a new worksheet in a specified workbook, with full request parameters and response field references.

Call this API to create a new worksheet in a spreadsheet document.

## Request

### Basic information

| Field                | Value                                                                    |
| -------------------- | ------------------------------------------------------------------------ |
| HTTP URL             | `https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets`         |
| HTTP Method          | POST                                                                     |
| Supported app types  | appType-Internal app　appType-Third-party enterprise app                  |
| Required permissions | permission-Document.Workbook.Write-DingTalk Spreadsheet write permission |

### Request headers

| Name                        | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| --------------------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| x-acs-dingtalk-access-token | String | Yes      | The access credential for calling 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 an authorized organization for a third-party app](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#) API. |

### Path parameters

| Name       | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                                 |
| ---------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| workbookId | String | Yes      | The ID of the spreadsheet file. The `nodeId(dentryUuid)` returned by the [Knowledge Base API](/open/development/knowledge-base-overview#) is the `workbookId` of the spreadsheet. Obtain it by calling the [Get a node](https://open.dingtalk.com/document/development/get-node#) or [Create a Knowledge Base document](/open/development/create-team-space-document#) API. |

### Query parameters

| Name       | Type   | Required | Description                                                                                                                                                                                                                                   |
| ---------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| operatorId | String | Yes      | The unionId of the operator. Obtain it by calling the [Query user details](/open/development/query-user-details#) API.    If the operator does not have the required permissions, the API returns the error `The operator has no permission`. |

### Request body

| Name | Type   | Required | Description                                                                                                                                 |
| ---- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| name | String | Yes      | The name of the worksheet.    If the specified worksheet name conflicts with an existing one, it is automatically renamed to a valid value. |

### Request example

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v1.0/doc/workbooks/e54Lqxxx/sheets?operatorId=ppgAQuHfOoNVpJiStDwWCEgiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "name" : "Sheet1"
}
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Initialize the account Client with a Token
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkdoc_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.dingtalkdoc_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_1_0.models.CreateSheetHeaders createSheetHeaders = new com.aliyun.dingtalkdoc_1_0.models.CreateSheetHeaders();
        createSheetHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.CreateSheetRequest createSheetRequest = new com.aliyun.dingtalkdoc_1_0.models.CreateSheetRequest()
                .setOperatorId("ppgAQuHfOoNVpJiStDwWCEgiEiE")
                .setName("Sheet1");
        try {
            client.createSheetWithOptions("e54Lqxxx", createSheetRequest, createSheetHeaders, 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 sys

from typing import List

from alibabacloud_dingtalk.doc_1_0.client import Client as dingtalkdoc_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_1_0 import models as dingtalkdoc__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() -> dingtalkdoc_1_0Client:
        """
        Initialize the account Client with a Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkdoc_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_sheet_headers = dingtalkdoc__1__0_models.CreateSheetHeaders()
        create_sheet_headers.x_acs_dingtalk_access_token = '<your access token>'
        create_sheet_request = dingtalkdoc__1__0_models.CreateSheetRequest(
            operator_id='ppgAQuHfOoNVpJiStDwWCEgiEiE',
            name='Sheet1'
        )
        try:
            client.create_sheet_with_options('e54Lqxxx', create_sheet_request, create_sheet_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()
        create_sheet_headers = dingtalkdoc__1__0_models.CreateSheetHeaders()
        create_sheet_headers.x_acs_dingtalk_access_token = '<your access token>'
        create_sheet_request = dingtalkdoc__1__0_models.CreateSheetRequest(
            operator_id='ppgAQuHfOoNVpJiStDwWCEgiEiE',
            name='Sheet1'
        )
        try:
            await client.create_sheet_with_options_async('e54Lqxxx', create_sheet_request, create_sheet_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\Vdoc_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateSheetHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateSheetRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with a 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();
        $createSheetHeaders = new CreateSheetHeaders([]);
        $createSheetHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $createSheetRequest = new CreateSheetRequest([
            "operatorId" => "ppgAQuHfOoNVpJiStDwWCEgiEiE",
            "name" => "Sheet1"
        ]);
        try {
            $client->createSheetWithOptions("e54Lqxxx", $createSheetRequest, $createSheetHeaders, 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"}}
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkdoc_1_0  "github.com/alibabacloud-go/dingtalk/doc_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

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

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

  createSheetHeaders := &dingtalkdoc_1_0.CreateSheetHeaders{}
  createSheetHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  createSheetRequest := &dingtalkdoc_1_0.CreateSheetRequest{
    OperatorId: tea.String("ppgAQuHfOoNVpJiStDwWCEgiEiE"),
    Name: tea.String("Sheet1"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CreateSheetWithOptions(tea.String("e54Lqxxx"), createSheetRequest, createSheetHeaders, &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

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkdoc_1_0, * as $dingtalkdoc_1_0 from '@alicloud/dingtalk/doc_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

  /**
   * Initialize the account Client with a Token
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkdoc_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkdoc_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let createSheetHeaders = new $dingtalkdoc_1_0.CreateSheetHeaders({ });
    createSheetHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let createSheetRequest = new $dingtalkdoc_1_0.CreateSheetRequest({
      operatorId: "ppgAQuHfOoNVpJiStDwWCEgiEiE",
      name: "Sheet1",
    });
    try {
      await client.createSheetWithOptions("e54Lqxxx", createSheetRequest, createSheetHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains the code and message attributes, which help locate the issue
      }

    }    
  }

}

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

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.

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 
    {

        /**
         * Initialize the account Client with a Token
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkdoc_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateSheetHeaders createSheetHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateSheetHeaders();
            createSheetHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateSheetRequest createSheetRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateSheetRequest
            {
                OperatorId = "ppgAQuHfOoNVpJiStDwWCEgiEiE",
                Name = "Sheet1",
            };
            try
            {
                client.CreateSheetWithOptions("e54Lqxxx", createSheetRequest, createSheetHeaders, 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                                                  |
| ---------- | ------ | ------------------------------------------------------------ |
| visibility | String | The visibility of the worksheet. The fixed value is visible. |
| name       | String | The name of the worksheet.                                   |
| id         | String | The ID of the worksheet.                                     |

### Response body example

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

{
  "visibility" : "visible",
  "name" : "Sheet1",
  "id" : "st-xxxxx"
}
```

### Error codes

If an error is returned when calling this API, look up the solution in the [Global error codes](/open/development/server-api-error-codes-1) document based on the error message.

| HttpCode | Error code                                 | Error message                                                                                                                                       | Description                                                                                                                                                                                  |
| -------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400      | invalidRequest.inputArgs.workbookIdIllegal | The workbookId is illegal.                                                                                                                          | The workbookId is invalid.                                                                                                                                                                   |
| 400      | invalidRequest.inputArgs.operatorIdIllegal | The operatorId is illegal.                                                                                                                          | The operatorId is invalid.                                                                                                                                                                   |
| 400      | invalidRequest.inputArgs.invalid           | %s                                                                                                                                                  | The request parameter is invalid. Possible errors include an incorrect range address, incorrect input parameter dimensions, or an incorrect color format. See the error message for details. |
| 403      | forbidden.operationIllegal                 | %s                                                                                                                                                  | The requested action is not allowed. Possible errors include no permission to access locked cells, or modifying cells related to a pivot table or to-do. See the error message for details.  |
| 403      | forbidden.accessDenied                     | The operator has no permission.                                                                                                                     | The current user does not have permission for this action.                                                                                                                                   |
| 403      | forbidden.document.sizeOverLimit           | The document size is over limit and the server is unable to complete your request. Retry is unlikely to work unless the document size is decreased. | The spreadsheet content is too large. Reduce its size and try again.                                                                                                                         |
| 404      | invalidRequest.resource.notFound           | %s                                                                                                                                                  | The request failed because the requested resource could not be found.                                                                                                                        |
| 500      | internalError                              | The server encountered an internal error and was unable to complete your request. Please try again later.                                           | Internal server error. Try again later.                                                                                                                                                      |
| 503      | serviceBusy                                | The server is busy and unable to complete your request. Please try again later.                                                                     | The service is busy. Try again later.                                                                                                                                                        |