Skip to main content
Call this API to update the content or attributes of any single block element in a document.

API call description

  • This is essentially a PATCH operation (non-idempotent). Only the fields passed in are updated; fields not passed in remain unchanged.
  • Currently, only block elements of the paragraph type can be updated.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/doc/suites/documents/{documentId}/blocks/{blockId}
HTTP MethodPUT
Supported app typeappType-Internal app
Permissions requiredpermission-Storage.File.Write-Organization storage file write permission

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential used to call this API. Obtain it by calling the Get the access token of an internal app API.

Path parameter

NameTypeRequiredDescription
documentIdStringYesThe document ID (the document’s docKey or dentryUuid). After creating a document by calling the Create Knowledge Base document API, obtain the docKey parameter from the response. To obtain the dentryUuid from the document URL, take https://alidocs.dingtalk.io/i/nodes/Zxxxxa-id as an example, where dentryUuid is Zxxxxa-id.
blockIdStringYesThe unique identifier of the target paragraph. Obtain the blockId parameter of this paragraph by calling the Query block elements API.

Query parameter

NameTypeRequiredDescription
operatorIdStringYesThe user’s unionId. Obtain the unionid parameter value by calling the Query user details API.

Request body

NameTypeRequiredDescription
elementMap<String, Any>YesThe BlockElement type of the block element to update and the attributes required for the corresponding type (see Block element data structure for details). The structure is as follows: { "blockType": enum(BlockType), [blockType]: Object(ElementProperties), }
AnyNoThe attributes of the block element to update.

Request example

HTTP
PUT /v1.0/doc/suites/documents/doc_id/blocks/block_id?operatorId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json

{
  "element" : {
    "blockType" : "paragraph",
    "paragraph" : {
      "folded": true
    }
  }
}
Java
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.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.DocBlocksModifyHeaders docBlocksModifyHeaders = new com.aliyun.dingtalkdoc_1_0.models.DocBlocksModifyHeaders();
        docBlocksModifyHeaders.xAcsDingtalkAccessToken = "<your access token>";
        java.util.Map<String, java.util.Map<String, Object>> element = TeaConverter.buildMap(
            new TeaPair("key", new java.util.HashMap<>())
        );
        com.aliyun.dingtalkdoc_1_0.models.DocBlocksModifyRequest docBlocksModifyRequest = new com.aliyun.dingtalkdoc_1_0.models.DocBlocksModifyRequest()
                .setOperatorId("union_id")
                .setElement(element);
        try {
            client.docBlocksModifyWithOptions("doc_id", "block_id", docBlocksModifyRequest, docBlocksModifyHeaders, 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 code and message attributes that 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 code and message attributes that help 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 the 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()
        doc_blocks_modify_headers = dingtalkdoc__1__0_models.DocBlocksModifyHeaders()
        doc_blocks_modify_headers.x_acs_dingtalk_access_token = '<your access token>'
        element = {
            'key': {}
        }
        doc_blocks_modify_request = dingtalkdoc__1__0_models.DocBlocksModifyRequest(
            operator_id='union_id',
            element=element
        )
        try:
            client.doc_blocks_modify_with_options('doc_id', 'block_id', doc_blocks_modify_request, doc_blocks_modify_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        doc_blocks_modify_headers = dingtalkdoc__1__0_models.DocBlocksModifyHeaders()
        doc_blocks_modify_headers.x_acs_dingtalk_access_token = '<your access token>'
        element = {
            'key': {}
        }
        doc_blocks_modify_request = dingtalkdoc__1__0_models.DocBlocksModifyRequest(
            operator_id='union_id',
            element=element
        )
        try:
            await client.doc_blocks_modify_with_options_async('doc_id', 'block_id', doc_blocks_modify_request, doc_blocks_modify_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that help 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\DocBlocksModifyHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\DocBlocksModifyRequest;
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();
        $docBlocksModifyHeaders = new DocBlocksModifyHeaders([]);
        $docBlocksModifyHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $element = [
            "key" => []
        ];
        $docBlocksModifyRequest = new DocBlocksModifyRequest([
            "operatorId" => "union_id",
            "element" => $element
        ]);
        try {
            $client->docBlocksModifyWithOptions("doc_id", "block_id", $docBlocksModifyRequest, $docBlocksModifyHeaders, 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 code and message attributes that 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
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 the 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
  }

  docBlocksModifyHeaders := &dingtalkdoc_1_0.DocBlocksModifyHeaders{}
  docBlocksModifyHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  element := map[string]map[string]interface{}{
    "key": map[string]interface{}{},
  }
  docBlocksModifyRequest := &dingtalkdoc_1_0.DocBlocksModifyRequest{
    OperatorId: tea.String("union_id"),
    Element: element,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DocBlocksModifyWithOptions(tea.String("doc_id"), tea.String("block_id"), docBlocksModifyRequest, docBlocksModifyHeaders, &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 code and message attributes that help 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 the 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 docBlocksModifyHeaders = new dingtalkdoc_1_0.DocBlocksModifyHeaders({ });
    docBlocksModifyHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let element = {
      key: { },
    };
    let docBlocksModifyRequest = new dingtalkdoc_1_0.DocBlocksModifyRequest({
      operatorId: 'union_id',
      element: element,
    });
    try {
      await client.docBlocksModifyWithOptions('doc_id', 'block_id', docBlocksModifyRequest, docBlocksModifyHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message attributes that help 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 the 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.DocBlocksModifyHeaders docBlocksModifyHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocBlocksModifyHeaders();
            docBlocksModifyHeaders.XAcsDingtalkAccessToken = "<your access token>";
            Dictionary<string, Dictionary<string, object>> element = new Dictionary<string, Dictionary<string, object>>
            {
                {"key", new Dictionary<string, object>(){}},
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocBlocksModifyRequest docBlocksModifyRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocBlocksModifyRequest
            {
                OperatorId = "union_id",
                Element = element,
            };
            try
            {
                client.DocBlocksModifyWithOptions("doc_id", "block_id", docBlocksModifyRequest, docBlocksModifyHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message attributes that 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 code and message attributes that help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
successBooleanWhether the request was successful.
resultObjectThe request result.
resultArray of AnyThe request result.

Response body example

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

{
  "success" : true,
  "result" : {
    "result" : [ "{}" ]
  }
}

Error codes

If an error is returned when you call this API, look up the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400paramError%sParameter error.
400invalidRequest.inputArgs.invalid%sParameter error. See the error message for details.
403forbidden.accessDenied%sNo permissions.
403forbidden.acrossOrg%sThe request is invalid. Check whether the document to access belongs to the organization specified by the access token.
404docNotExist%sThe document does not exist.
404invalidRequest.resource.notFound%sThe resource to access cannot be found.
500forbidden.operationIllegal%sThe requested operation is invalid.
500systemError%sThe service is busy. Try again later.
500unknownErrorUnknown ErrorUnknown error.
503operationTimeout%sThe request timed out.