Skip to main content
Call this API to delete a document or folder in a team space.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/doc/workspaces/{workspaceId}/docs/{nodeId}
HTTP MethodDELETE
Supported app typeappType-Internal app
Required permissionpermission-Document.WorkspaceDocument.Write-Knowledge Base document write permission

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential used to call this API. To obtain it, call the Get the access token of an internal app API.

Path parameters

NameTypeRequiredDescription
workspaceIdStringYesThe team space ID. To obtain it, call the Create a Knowledge Base API or the Get the Knowledge Base list API and use the value of the workspaceId field.
nodeIdStringYesThe team space node ID. You can pass either a document ID or a folder ID. To obtain it, call the Create a Knowledge Base document API and use the value of the nodeId parameter.

Query parameters

NameTypeRequiredDescription
operatorIdStringYesThe unionId of the user who initiates the delete request. To obtain it, call the Query user details API and use the value of the unionid parameter.

Request example

HTTP
DELETE /v1.0/doc/workspaces/abc/docs/def?operatorId=xyz HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxx_token
Content-Type:application/json
Java
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with a 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.DeleteWorkspaceDocHeaders deleteWorkspaceDocHeaders = new com.aliyun.dingtalkdoc_1_0.models.DeleteWorkspaceDocHeaders();
        deleteWorkspaceDocHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.DeleteWorkspaceDocRequest deleteWorkspaceDocRequest = new com.aliyun.dingtalkdoc_1_0.models.DeleteWorkspaceDocRequest()
                .setOperatorId("xyz");
        try {
            client.deleteWorkspaceDocWithOptions("abc", "def", deleteWorkspaceDocRequest, deleteWorkspaceDocHeaders, 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 can 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)) {
                // err contains the code and message Attributes, which can 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 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()
        delete_workspace_doc_headers = dingtalkdoc__1__0_models.DeleteWorkspaceDocHeaders()
        delete_workspace_doc_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_workspace_doc_request = dingtalkdoc__1__0_models.DeleteWorkspaceDocRequest(
            operator_id='xyz'
        )
        try:
            client.delete_workspace_doc_with_options('abc', 'def', delete_workspace_doc_request, delete_workspace_doc_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 can help developers locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        delete_workspace_doc_headers = dingtalkdoc__1__0_models.DeleteWorkspaceDocHeaders()
        delete_workspace_doc_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_workspace_doc_request = dingtalkdoc__1__0_models.DeleteWorkspaceDocRequest(
            operator_id='xyz'
        )
        try:
            await client.delete_workspace_doc_with_options_async('abc', 'def', delete_workspace_doc_request, delete_workspace_doc_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 can 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\DeleteWorkspaceDocHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\DeleteWorkspaceDocRequest;
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();
        $deleteWorkspaceDocHeaders = new DeleteWorkspaceDocHeaders([]);
        $deleteWorkspaceDocHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $deleteWorkspaceDocRequest = new DeleteWorkspaceDocRequest([
            "operatorId" => "xyz"
        ]);
        try {
            $client->deleteWorkspaceDocWithOptions("abc", "def", $deleteWorkspaceDocRequest, $deleteWorkspaceDocHeaders, 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 can 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 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
  }

  deleteWorkspaceDocHeaders := &dingtalkdoc_1_0.DeleteWorkspaceDocHeaders{}
  deleteWorkspaceDocHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  deleteWorkspaceDocRequest := &dingtalkdoc_1_0.DeleteWorkspaceDocRequest{
    OperatorId: tea.String("xyz"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DeleteWorkspaceDocWithOptions(tea.String("abc"), tea.String("def"), deleteWorkspaceDocRequest, deleteWorkspaceDocHeaders, &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 can 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 with a 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 deleteWorkspaceDocHeaders = new dingtalkdoc_1_0.DeleteWorkspaceDocHeaders({ });
    deleteWorkspaceDocHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let deleteWorkspaceDocRequest = new dingtalkdoc_1_0.DeleteWorkspaceDocRequest({
      operatorId: 'xyz',
    });
    try {
      await client.deleteWorkspaceDocWithOptions('abc', 'def', deleteWorkspaceDocRequest, deleteWorkspaceDocHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message Attributes, which can 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 with a 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.DeleteWorkspaceDocHeaders deleteWorkspaceDocHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DeleteWorkspaceDocHeaders();
            deleteWorkspaceDocHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DeleteWorkspaceDocRequest deleteWorkspaceDocRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DeleteWorkspaceDocRequest
            {
                OperatorId = "xyz",
            };
            try
            {
                client.DeleteWorkspaceDocWithOptions("abc", "def", deleteWorkspaceDocRequest, deleteWorkspaceDocHeaders, 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 can 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))
                {
                    // err contains the code and message Attributes, which can help developers locate the issue
                }
            }
        }

    }
}

Response

Response body example

HTTP/1.1 200 OK

Error codes

If an error occurs when you call this API, look up the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400invalidRequest.inputArgs.invalidMethod parameter validation failedMethod parameter validation failed. Check whether any required parameters are missing or whether the unionId is valid.
400invalidRequest.workspaceNode.notInWorkspaceThe node is not in the Knowledge BaseThe node is not in the Knowledge Base.
403forbidden.user.notInOrgThe operating user is not in the organizationThe operating user is not in the organization.
403forbidden.accessDeniedThe user does not have operation permissionThe user does not have operation permission.
404invalidRequest.resource.notFoundThe resource is not foundThe Knowledge Base, node, or other resource is not found.
404invalidRequest.document.deletedThe Knowledge Base node has been deletedThe Knowledge Base node has been deleted.
404invalidRequest.workspace.deletedThe Knowledge Base has been deletedThe Knowledge Base has been deleted.
500internalErrorInternal system errorInternal system error.