Skip to main content
Call this API to create a conditional formatting rule in a specified Worksheet of a DingTalk Spreadsheet. The rule automatically applies highlighting styles based on cell values or duplicate status. This is useful for scenarios where data needs visual marking — for example, highlighting cells below a target value in red, highlighting duplicate entries for easy review, or distinguishing values within a specific range with a designated background color. Once the rule is created, cells that meet the conditions will automatically apply the specified font color or background color, eliminating the need to set each one manually.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/conditionalFormattingRules
HTTP MethodPOST
Supported app typeappType-Internal app
Required permissionspermission-Document.Workbook.Write-DingTalk Spreadsheet write permission

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe Access credential for calling this API. Call the Get the access token of an internal app API to obtain it.

Path parameter

NameTypeRequiredDescription
workbookIdStringYesThe Spreadsheet File ID. The nodeId(dentryUuid) returned by the Knowledge Base API is the Spreadsheet workbookId. Call the Get node or Create Knowledge Base document API to obtain it.
sheetIdStringYesThe Worksheet ID or title. Call the Get all worksheets API to obtain the ID and title of the Worksheet.

Query parameter

NameTypeRequiredDescription
operatorIdStringYesThe unionId of the operator. Call the Query user details API to obtain it. If the operator does not have permission, the API returns the error The operator has no permission.

Request body

NameTypeRequiredDescription
rangesArray of StringYesThe Cell address in A1 notation.
duplicateConditionObjectNoThe duplicate value rule.
operatorStringNoThe operator. Currently, only duplicate is supported, which represents duplicate items.
numberConditionObjectNoThe Number rule.
operatorStringNoThe comparison operator. Valid values: - equal: Equal to - not-equal: Not equal to - greater: Greater than - greater-equal: Greater than or equal to - less: Less than - less-equal: Less than or equal to - between: Between two values (inclusive) - not-between: Not between two values
value1AnyNovalue1 — The first comparison value (required).
value2AnyNovalue2 — The second comparison value (optional). It is required only when operator is between or not-between, serving as the upper bound of the range.
cellStyleObjectNoThe Cell style for the currently configured rule.
backgroundColorStringNoThe background color in hexadecimal notation, for example, #ff0000.
fontColorStringNoThe Font color.

Request example

HTTP
POST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/conditionalFormattingRules?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "ranges" : [ "A1:B2" ],
  "duplicateCondition" : {
    "operator" : "duplicate"
  },
  "numberCondition" : {
    "operator" : "between",
    "value1" : "10",
    "value2" : "50"
  },
  "cellStyle" : {
    "backgroundColor" : "#ff0000",
    "fontColor" : "#ff0000"
  }
}
Java
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using Token</p>
     * @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 {
        
        com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_1_0.models.CreateConditionalFormattingRuleHeaders createConditionalFormattingRuleHeaders = new com.aliyun.dingtalkdoc_1_0.models.CreateConditionalFormattingRuleHeaders();
        createConditionalFormattingRuleHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.CreateConditionalFormattingRuleRequest.CreateConditionalFormattingRuleRequestCellStyle cellStyle = new com.aliyun.dingtalkdoc_1_0.models.CreateConditionalFormattingRuleRequest.CreateConditionalFormattingRuleRequestCellStyle()
                .setBackgroundColor("#ff0000")
                .setFontColor("#ff0000");
        com.aliyun.dingtalkdoc_1_0.models.CreateConditionalFormattingRuleRequest.CreateConditionalFormattingRuleRequestNumberCondition numberCondition = new com.aliyun.dingtalkdoc_1_0.models.CreateConditionalFormattingRuleRequest.CreateConditionalFormattingRuleRequestNumberCondition()
                .setOperator("between")
                .setValue1(10)
                .setValue2(50);
        com.aliyun.dingtalkdoc_1_0.models.CreateConditionalFormattingRuleRequest.CreateConditionalFormattingRuleRequestDuplicateCondition duplicateCondition = new com.aliyun.dingtalkdoc_1_0.models.CreateConditionalFormattingRuleRequest.CreateConditionalFormattingRuleRequestDuplicateCondition()
                .setOperator("duplicate");
        com.aliyun.dingtalkdoc_1_0.models.CreateConditionalFormattingRuleRequest createConditionalFormattingRuleRequest = new com.aliyun.dingtalkdoc_1_0.models.CreateConditionalFormattingRuleRequest()
                .setOperatorId("ppgAxxx")
                .setRanges(java.util.Arrays.asList(
                    "A1:B2"
                ))
                .setDuplicateCondition(duplicateCondition)
                .setNumberCondition(numberCondition)
                .setCellStyle(cellStyle);
        try {
            client.createConditionalFormattingRuleWithOptions("e54Lq3xxx", "Sheet1", createConditionalFormattingRuleRequest, createConditionalFormattingRuleHeaders, 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, which help developers 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)) {
                // The err contains code and message attributes, which help developers locate the issue.
            }

        }        
    }
}
Python
# -*- 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.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 using 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_conditional_formatting_rule_headers = dingtalkdoc__1__0_models.CreateConditionalFormattingRuleHeaders()
        create_conditional_formatting_rule_headers.x_acs_dingtalk_access_token = '<your access token>'
        cell_style = dingtalkdoc__1__0_models.CreateConditionalFormattingRuleRequestCellStyle(
            background_color='#ff0000',
            font_color='#ff0000'
        )
        number_condition = dingtalkdoc__1__0_models.CreateConditionalFormattingRuleRequestNumberCondition(
            operator='between',
            value_1=10,
            value_2=50
        )
        duplicate_condition = dingtalkdoc__1__0_models.CreateConditionalFormattingRuleRequestDuplicateCondition(
            operator='duplicate'
        )
        create_conditional_formatting_rule_request = dingtalkdoc__1__0_models.CreateConditionalFormattingRuleRequest(
            operator_id='ppgAxxx',
            ranges=[
                'A1:B2'
            ],
            duplicate_condition=duplicate_condition,
            number_condition=number_condition,
            cell_style=cell_style
        )
        try:
            client.create_conditional_formatting_rule_with_options('e54Lq3xxx', 'Sheet1', create_conditional_formatting_rule_request, create_conditional_formatting_rule_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, which help developers locate the issue.
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_conditional_formatting_rule_headers = dingtalkdoc__1__0_models.CreateConditionalFormattingRuleHeaders()
        create_conditional_formatting_rule_headers.x_acs_dingtalk_access_token = '<your access token>'
        cell_style = dingtalkdoc__1__0_models.CreateConditionalFormattingRuleRequestCellStyle(
            background_color='#ff0000',
            font_color='#ff0000'
        )
        number_condition = dingtalkdoc__1__0_models.CreateConditionalFormattingRuleRequestNumberCondition(
            operator='between',
            value_1=10,
            value_2=50
        )
        duplicate_condition = dingtalkdoc__1__0_models.CreateConditionalFormattingRuleRequestDuplicateCondition(
            operator='duplicate'
        )
        create_conditional_formatting_rule_request = dingtalkdoc__1__0_models.CreateConditionalFormattingRuleRequest(
            operator_id='ppgAxxx',
            ranges=[
                'A1:B2'
            ],
            duplicate_condition=duplicate_condition,
            number_condition=number_condition,
            cell_style=cell_style
        )
        try:
            await client.create_conditional_formatting_rule_with_options_async('e54Lq3xxx', 'Sheet1', create_conditional_formatting_rule_request, create_conditional_formatting_rule_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, which help developers locate the issue.
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
PHP
<?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\CreateConditionalFormattingRuleHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateConditionalFormattingRuleRequest\cellStyle;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateConditionalFormattingRuleRequest\numberCondition;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateConditionalFormattingRuleRequest\duplicateCondition;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateConditionalFormattingRuleRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $createConditionalFormattingRuleHeaders = new CreateConditionalFormattingRuleHeaders([]);
        $createConditionalFormattingRuleHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $cellStyle = new cellStyle([
            "backgroundColor" => "#ff0000",
            "fontColor" => "#ff0000"
        ]);
        $numberCondition = new numberCondition([
            "operator" => "between",
            "value1" => 10,
            "value2" => 50
        ]);
        $duplicateCondition = new duplicateCondition([
            "operator" => "duplicate"
        ]);
        $createConditionalFormattingRuleRequest = new CreateConditionalFormattingRuleRequest([
            "operatorId" => "ppgAxxx",
            "ranges" => [
                "A1:B2"
            ],
            "duplicateCondition" => $duplicateCondition,
            "numberCondition" => $numberCondition,
            "cellStyle" => $cellStyle
        ]);
        try {
            $client->createConditionalFormattingRuleWithOptions("e54Lq3xxx", "Sheet1", $createConditionalFormattingRuleRequest, $createConditionalFormattingRuleHeaders, 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, which help developers 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
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "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"
)

// Description:
// 
// Initialize the account Client using 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
  }

  createConditionalFormattingRuleHeaders := &dingtalkdoc_1_0.CreateConditionalFormattingRuleHeaders{}
  createConditionalFormattingRuleHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  cellStyle := &dingtalkdoc_1_0.CreateConditionalFormattingRuleRequestCellStyle{
    BackgroundColor: tea.String("#ff0000"),
    FontColor: tea.String("#ff0000"),
  }
  numberCondition := &dingtalkdoc_1_0.CreateConditionalFormattingRuleRequestNumberCondition{
    Operator: tea.String("between"),
    Value1: tea.Int(10),
    Value2: tea.Int(50),
  }
  duplicateCondition := &dingtalkdoc_1_0.CreateConditionalFormattingRuleRequestDuplicateCondition{
    Operator: tea.String("duplicate"),
  }
  createConditionalFormattingRuleRequest := &dingtalkdoc_1_0.CreateConditionalFormattingRuleRequest{
    OperatorId: tea.String("ppgAxxx"),
    Ranges: []*string{tea.String("A1:B2")},
    DuplicateCondition: duplicateCondition,
    NumberCondition: numberCondition,
    CellStyle: cellStyle,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CreateConditionalFormattingRuleWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), createConditionalFormattingRuleRequest, createConditionalFormattingRuleHeaders, &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, which help developers locate the issue.
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkdoc_1_0 = require('@alicloud/dingtalk/doc_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

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

  static async main(args) {
    let client = Client.createClient();
    let createConditionalFormattingRuleHeaders = new dingtalkdoc_1_0.CreateConditionalFormattingRuleHeaders({ });
    createConditionalFormattingRuleHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let cellStyle = new dingtalkdoc_1_0.CreateConditionalFormattingRuleRequestCellStyle({
      backgroundColor: '#ff0000',
      fontColor: '#ff0000',
    });
    let numberCondition = new dingtalkdoc_1_0.CreateConditionalFormattingRuleRequestNumberCondition({
      operator: 'between',
      value1: 10,
      value2: 50,
    });
    let duplicateCondition = new dingtalkdoc_1_0.CreateConditionalFormattingRuleRequestDuplicateCondition({
      operator: 'duplicate',
    });
    let createConditionalFormattingRuleRequest = new dingtalkdoc_1_0.CreateConditionalFormattingRuleRequest({
      operatorId: 'ppgAxxx',
      ranges: [
        'A1:B2'
      ],
      duplicateCondition: duplicateCondition,
      numberCondition: numberCondition,
      cellStyle: cellStyle,
    });
    try {
      await client.createConditionalFormattingRuleWithOptions('e54Lq3xxx', 'Sheet1', createConditionalFormattingRuleRequest, createConditionalFormattingRuleHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // The err contains code and message attributes, which help developers locate the issue.
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
C#
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 Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// 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.CreateConditionalFormattingRuleHeaders createConditionalFormattingRuleHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateConditionalFormattingRuleHeaders();
            createConditionalFormattingRuleHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateConditionalFormattingRuleRequest.CreateConditionalFormattingRuleRequestCellStyle cellStyle = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateConditionalFormattingRuleRequest.CreateConditionalFormattingRuleRequestCellStyle
            {
                BackgroundColor = "#ff0000",
                FontColor = "#ff0000",
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateConditionalFormattingRuleRequest.CreateConditionalFormattingRuleRequestNumberCondition numberCondition = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateConditionalFormattingRuleRequest.CreateConditionalFormattingRuleRequestNumberCondition
            {
                Operator = "between",
                Value1 = 10,
                Value2 = 50,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateConditionalFormattingRuleRequest.CreateConditionalFormattingRuleRequestDuplicateCondition duplicateCondition = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateConditionalFormattingRuleRequest.CreateConditionalFormattingRuleRequestDuplicateCondition
            {
                Operator = "duplicate",
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateConditionalFormattingRuleRequest createConditionalFormattingRuleRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateConditionalFormattingRuleRequest
            {
                OperatorId = "ppgAxxx",
                Ranges = new List<string>
                {
                    "A1:B2"
                },
                DuplicateCondition = duplicateCondition,
                NumberCondition = numberCondition,
                CellStyle = cellStyle,
            };
            try
            {
                client.CreateConditionalFormattingRuleWithOptions("e54Lq3xxx", "Sheet1", createConditionalFormattingRuleRequest, createConditionalFormattingRuleHeaders, 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, which help developers 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))
                {
                    // The err contains code and message attributes, which help developers locate the issue.
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
idStringThe conditional formatting ID.

Response body example

HTTP/1.1 200 OK
Content-Type:application/json

{
  "id" : "cf-xxxxx"
}

Error codes

If an error occurs when calling this API, look up the error message in the Global error codes documentation for a solution.
HttpCodeError codeError messageDescription
400invalidRequest.inputArgs.invalid%sInvalid request parameter. Review the error message.
400invalidRequest.inputArgs.workbookIdIllegalThe workbookId is illegal.The workbookId is invalid.
400invalidRequest.resource.notWorkbook%sUnsupported document type. Check the workbookId.
400invalidRequest.document.stillInitializingThe document is still initializing. Please try again later.The document is initializing. Try again later.
403forbidden.accessDeniedThe operator has no permission.The current User does not have permission for this Action.
403forbidden.acrossOrg%sInvalid request. Check whether the target Document belongs to the Organization specified by the access token.
403forbidden.operationIllegal%sInvalid request Action. Review the error message.
403forbidden.document.sizeOverLimitThe 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.
404invalidRequest.resource.notFound%sThe request Failed. The target resource could not be found.
500serviceBusyThe server is busy and unable to complete your request. Please try again later.The service is busy. Try again later.
500internalErrorThe server encountered an internal error and was unable to complete your request. Please try again later.An internal service Error occurred. Try again later.