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

# Insert dropdown lists

> Call this API to set dropdown options for a specified cell range in a DingTalk Spreadsheet, supporting custom text and label colors for standardized data entry.

Call this API to configure dropdown list options for a specified cell range in a DingTalk Spreadsheet. You can customize the text value and label color of each option. This API is useful for standardizing data entry and providing preset options (such as status or category). Once configured, users can only select values from the predefined options.

## Request

### Basic information

| Field               | Value                                                                                                                |
| ------------------- | -------------------------------------------------------------------------------------------------------------------- |
| HTTP URL            | `https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/ranges/{rangeAddress}/insertDropdownLists` |
| HTTP Method         | POST                                                                                                                 |
| Supported app type  | appType-Internal app                                                                                                 |
| Required permission | 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. To obtain it, call the [Get the access token of an internal app](/open/development/obtain-the-access-token-of-an-internal-app) API. |

### Path parameters

| Name         | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                     |
| ------------ | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| workbookId   | String | Yes      | The Spreadsheet file ID. The `nodeId(dentryUuid)` returned by the [Knowledge Base API](/open/development/knowledge-base-overview) is the `workbookId` of the Spreadsheet. To obtain it, call 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. |
| sheetId      | String | Yes      | The worksheet ID or title. To obtain the ID and title, call the [Get all worksheets](/open/development/obtain-all-worksheets) API.                                                                                                                                                                                                                              |
| rangeAddress | String | Yes      | The range address.                                                                                                                                                                                                                                                                                                                                              |

### Query parameters

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

### Request body

| Name    | Type   | Required | Description                                                                                     |
| ------- | ------ | -------- | ----------------------------------------------------------------------------------------------- |
| options | Array  | Yes      | The array of dropdown list options.                                                             |
| value   | String | Yes      | The value of the dropdown list option.                                                          |
| color   | String | No       | The color of the dropdown list option, expressed in hexadecimal notation. For example, #ff0000. |

### Request example

HTTP

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

{
  "options" : [ {
    "value" : "Option 1",
    "color" : "#ff0000"
  } ]
}
```

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.InsertDropdownListsHeaders insertDropdownListsHeaders = new com.aliyun.dingtalkdoc_1_0.models.InsertDropdownListsHeaders();
        insertDropdownListsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.InsertDropdownListsRequest.InsertDropdownListsRequestOptions options0 = new com.aliyun.dingtalkdoc_1_0.models.InsertDropdownListsRequest.InsertDropdownListsRequestOptions()
                .setValue("Option 1")
                .setColor("#ff0000");
        com.aliyun.dingtalkdoc_1_0.models.InsertDropdownListsRequest insertDropdownListsRequest = new com.aliyun.dingtalkdoc_1_0.models.InsertDropdownListsRequest()
                .setOperatorId("ppgAxxx")
                .setOptions(java.util.Arrays.asList(
                    options0
                ));
        try {
            client.insertDropdownListsWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", insertDropdownListsRequest, insertDropdownListsHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // The err contains code and message attributes that help with troubleshooting
            }

        } 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)) {
                // The err contains code and message attributes that help with troubleshooting
            }

        }        
    }
}
```

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()
        insert_dropdown_lists_headers = dingtalkdoc__1__0_models.InsertDropdownListsHeaders()
        insert_dropdown_lists_headers.x_acs_dingtalk_access_token = '<your access token>'
        options_0 = dingtalkdoc__1__0_models.InsertDropdownListsRequestOptions(
            value='Option 1',
            color='#ff0000'
        )
        insert_dropdown_lists_request = dingtalkdoc__1__0_models.InsertDropdownListsRequest(
            operator_id='ppgAxxx',
            options=[
                options_0
            ]
        )
        try:
            client.insert_dropdown_lists_with_options('e54Lq3xxx', 'Sheet1', 'A1:B1', insert_dropdown_lists_request, insert_dropdown_lists_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains code and message attributes that help with troubleshooting
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        insert_dropdown_lists_headers = dingtalkdoc__1__0_models.InsertDropdownListsHeaders()
        insert_dropdown_lists_headers.x_acs_dingtalk_access_token = '<your access token>'
        options_0 = dingtalkdoc__1__0_models.InsertDropdownListsRequestOptions(
            value='Option 1',
            color='#ff0000'
        )
        insert_dropdown_lists_request = dingtalkdoc__1__0_models.InsertDropdownListsRequest(
            operator_id='ppgAxxx',
            options=[
                options_0
            ]
        )
        try:
            await client.insert_dropdown_lists_with_options_async('e54Lq3xxx', 'Sheet1', 'A1:B1', insert_dropdown_lists_request, insert_dropdown_lists_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains code and message attributes that help with troubleshooting
                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\InsertDropdownListsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\InsertDropdownListsRequest\options;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\InsertDropdownListsRequest;
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();
        $insertDropdownListsHeaders = new InsertDropdownListsHeaders([]);
        $insertDropdownListsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $options0 = new options([
            "value" => "Option 1",
            "color" => "#ff0000"
        ]);
        $insertDropdownListsRequest = new InsertDropdownListsRequest([
            "operatorId" => "ppgAxxx",
            "options" => [
                $options0
            ]
        ]);
        try {
            $client->insertDropdownListsWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", $insertDropdownListsRequest, $insertDropdownListsHeaders, 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)) {
                // The err contains code and message attributes that help with troubleshooting
            }
        }
    }
}
$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
  }

  insertDropdownListsHeaders := &dingtalkdoc_1_0.InsertDropdownListsHeaders{}
  insertDropdownListsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  options0 := &dingtalkdoc_1_0.InsertDropdownListsRequestOptions{
    Value: tea.String("Option 1"),
    Color: tea.String("#ff0000"),
  }
  insertDropdownListsRequest := &dingtalkdoc_1_0.InsertDropdownListsRequest{
    OperatorId: tea.String("ppgAxxx"),
    Options: []*dingtalkdoc_1_0.InsertDropdownListsRequestOptions{options0},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.InsertDropdownListsWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("A1:B1"), insertDropdownListsRequest, insertDropdownListsHeaders, &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)) {
      // The err contains code and message attributes that help with troubleshooting
    }

  }
  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 insertDropdownListsHeaders = new $dingtalkdoc_1_0.InsertDropdownListsHeaders({ });
    insertDropdownListsHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let options0 = new $dingtalkdoc_1_0.InsertDropdownListsRequestOptions({
      value: "Option 1",
      color: "#ff0000",
    });
    let insertDropdownListsRequest = new $dingtalkdoc_1_0.InsertDropdownListsRequest({
      operatorId: "ppgAxxx",
      options: [
        options0
      ],
    });
    try {
      await client.insertDropdownListsWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", insertDropdownListsRequest, insertDropdownListsHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // The err contains code and message attributes that help with troubleshooting
      }

    }    
  }

}

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.InsertDropdownListsHeaders insertDropdownListsHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.InsertDropdownListsHeaders();
            insertDropdownListsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.InsertDropdownListsRequest.InsertDropdownListsRequestOptions options0 = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.InsertDropdownListsRequest.InsertDropdownListsRequestOptions
            {
                Value = "Option 1",
                Color = "#ff0000",
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.InsertDropdownListsRequest insertDropdownListsRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.InsertDropdownListsRequest
            {
                OperatorId = "ppgAxxx",
                Options = new List<AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.InsertDropdownListsRequest.InsertDropdownListsRequestOptions>
                {
                    options0
                },
            };
            try
            {
                client.InsertDropdownListsWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", insertDropdownListsRequest, insertDropdownListsHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err contains code and message attributes that help with troubleshooting
                }
            }
            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))
                {
                    // The err contains code and message attributes that help with troubleshooting
                }
            }
        }

    }
}
```

## Response

### Response body

| Name       | Type   | Description       |
| ---------- | ------ | ----------------- |
| a1Notation | String | The cell address. |

### Response body example

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

{
  "a1Notation" : "A1:B1"
}
```

### Error codes

If an error occurs when you call this API, refer to the [Global error codes](/open/development/server-api-error-codes-1) documentation based on the error message to find a solution.

| HttpCode | Error code                                 | Error message                                                                                                                                       | Description                                                                                                                   |
| -------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| 400      | invalidRequest.inputArgs.invalid           | %s                                                                                                                                                  | Invalid request parameter. Refer to the error message for details.                                                            |
| 400      | invalidRequest.inputArgs.workbookIdIllegal | The workbookId is illegal.                                                                                                                          | The workbookId is invalid.                                                                                                    |
| 400      | invalidRequest.resource.notWorkbook        | %s                                                                                                                                                  | Unsupported document type. Check the workbookId.                                                                              |
| 400      | invalidRequest.document.stillInitializing  | The document is still initializing. Please try again later.                                                                                         | The document is still initializing. Try again later.                                                                          |
| 403      | forbidden.operationIllegal                 | %s                                                                                                                                                  | Invalid request operation. Refer to the error message for details.                                                            |
| 403      | forbidden.accessDenied                     | The operator has no permission.                                                                                                                     | The current user does not have permission to perform this operation.                                                          |
| 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. Try reducing the content.                                                               |
| 403      | forbidden.acrossOrg                        | %s                                                                                                                                                  | Invalid request. Verify that the document you are trying to access belongs to the organization specified by the access token. |
| 404      | invalidRequest.resource.notFound           | %s                                                                                                                                                  | The request failed because the resource you are trying to access cannot be found.                                             |
| 500      | internalError                              | The server encountered an internal error and was unable to complete your request. Please try again later.                                           | Internal service error. Try again later.                                                                                      |
| 500      | serviceBusy                                | The server is busy and unable to complete your request. Please try again later.                                                                     | The service is busy. Try again later.                                                                                         |