Skip to main content
Call this API to delete a specific block element in a document.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/doc/suites/documents/{docKey}/blocks/{blockId}
HTTP MethodDELETE
Supported app typeappType-Internal app
Required permissionspermission-Storage.File.Write-Organization storage file write permission

Request headers

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 parameters

NameTypeRequiredDescription
docKeyStringYesThe document ID (the docKey or dentryUuid of the document). After creating a document by calling the Create a Knowledge Base document API, obtain the docKey from the response. Obtain the dentryUuid from the document URL. For example, for https://alidocs.dingtalk.io/i/nodes/Zxxxxa-id, the dentryUuid is Zxxxxa-id.
blockIdStringYesThe blockId of the block to delete. Obtain the blockId by calling the Query block elements API.

Query parameters

NameTypeRequiredDescription
operatorIdStringYesThe unionId of the user. Obtain the unionid by calling the Query user details API.

Request example

HTTP
DELETE /v1.0/doc/suites/documents/doc_key/blocks/block_id?operatorId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:7dc9ec4xxx
Content-Type:application/json
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.DocDeleteBlockHeaders docDeleteBlockHeaders = new com.aliyun.dingtalkdoc_1_0.models.DocDeleteBlockHeaders();
        docDeleteBlockHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.DocDeleteBlockRequest docDeleteBlockRequest = new com.aliyun.dingtalkdoc_1_0.models.DocDeleteBlockRequest()
                .setOperatorId("union_id");
        try {
            client.docDeleteBlockWithOptions("doc_key", "block_id", docDeleteBlockRequest, docDeleteBlockHeaders, 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 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 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_delete_block_headers = dingtalkdoc__1__0_models.DocDeleteBlockHeaders()
        doc_delete_block_headers.x_acs_dingtalk_access_token = '<your access token>'
        doc_delete_block_request = dingtalkdoc__1__0_models.DocDeleteBlockRequest(
            operator_id='union_id'
        )
        try:
            client.doc_delete_block_with_options('doc_key', 'block_id', doc_delete_block_request, doc_delete_block_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 locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        doc_delete_block_headers = dingtalkdoc__1__0_models.DocDeleteBlockHeaders()
        doc_delete_block_headers.x_acs_dingtalk_access_token = '<your access token>'
        doc_delete_block_request = dingtalkdoc__1__0_models.DocDeleteBlockRequest(
            operator_id='union_id'
        )
        try:
            await client.doc_delete_block_with_options_async('doc_key', 'block_id', doc_delete_block_request, doc_delete_block_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 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\DocDeleteBlockHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\DocDeleteBlockRequest;
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();
        $docDeleteBlockHeaders = new DocDeleteBlockHeaders([]);
        $docDeleteBlockHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $docDeleteBlockRequest = new DocDeleteBlockRequest([
            "operatorId" => "union_id"
        ]);
        try {
            $client->docDeleteBlockWithOptions("doc_key", "block_id", $docDeleteBlockRequest, $docDeleteBlockHeaders, 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 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
  }

  docDeleteBlockHeaders := &dingtalkdoc_1_0.DocDeleteBlockHeaders{}
  docDeleteBlockHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  docDeleteBlockRequest := &dingtalkdoc_1_0.DocDeleteBlockRequest{
    OperatorId: tea.String("union_id"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DocDeleteBlockWithOptions(tea.String("doc_key"), tea.String("block_id"), docDeleteBlockRequest, docDeleteBlockHeaders, &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 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 docDeleteBlockHeaders = new dingtalkdoc_1_0.DocDeleteBlockHeaders({ });
    docDeleteBlockHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let docDeleteBlockRequest = new dingtalkdoc_1_0.DocDeleteBlockRequest({
      operatorId: 'union_id',
    });
    try {
      await client.docDeleteBlockWithOptions('doc_key', 'block_id', docDeleteBlockRequest, docDeleteBlockHeaders, 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 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.DocDeleteBlockHeaders docDeleteBlockHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocDeleteBlockHeaders();
            docDeleteBlockHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocDeleteBlockRequest docDeleteBlockRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocDeleteBlockRequest
            {
                OperatorId = "union_id",
            };
            try
            {
                client.DocDeleteBlockWithOptions("doc_key", "block_id", docDeleteBlockRequest, docDeleteBlockHeaders, 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 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 locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
successBooleanWhether the API call succeeded.

Response body example

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

{
  "success" : true
}

Error codes

If an error occurs when calling 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. Check the error message.
403forbidden.accessDenied%sNo permission.
404docNotExist%sThe document does not exist.
404invalidRequest.resource.notFound%sThe resource to access cannot be found.
500forbidden.operationIllegal%sThe requested action is invalid.
500systemError%sThe service is busy. Try again later.
500unknownErrorUnknown ErrorUnknown error.
503operationTimeout%sRequest timed out.