Skip to main content
Call this API to overwrite a document by using Markdown.

Request

Basic information
HTTP URLhttps://api.dingtalk.io/v2.0/doc/me/suites/documents/{docKey}/overwriteContent
HTTP MethodPOST
Supported app typesappType-Internal app, appType-Third-party enterprise app
Required permissionspermission-qyapi_report_manage-Employee log data management permission

Query parameters

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential used to call this API. Obtain it through the Obtain user token API.

Path parameters

NameTypeRequiredDescription
docKeyStringYesThe document ID (doc_key or dentryUuid).

Request body

NameTypeRequiredDescription
dataTypeStringNoThe data type of the overwritten content.
contentStringYesThe content body.

Request example

HTTP
POST /v2.0/doc/me/suites/documents/Z90D4da/overwriteContent HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json

{
  "dataType" : "markdown",
  "content" : "# Heading"
}
Java
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account client by using a token</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkdoc_2_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_2_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkdoc_2_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_2_0.models.DocUpdateContentWithDelegatedPermissionHeaders docUpdateContentWithDelegatedPermissionHeaders = new com.aliyun.dingtalkdoc_2_0.models.DocUpdateContentWithDelegatedPermissionHeaders();
        docUpdateContentWithDelegatedPermissionHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_2_0.models.DocUpdateContentWithDelegatedPermissionRequest docUpdateContentWithDelegatedPermissionRequest = new com.aliyun.dingtalkdoc_2_0.models.DocUpdateContentWithDelegatedPermissionRequest()
                .setDataType("markdown")
                .setContent("# Heading");
        try {
            client.docUpdateContentWithDelegatedPermissionWithOptions("Z90D4da", docUpdateContentWithDelegatedPermissionRequest, docUpdateContentWithDelegatedPermissionHeaders, 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 object 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)) {
                // The err object 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

from typing import List

from alibabacloud_dingtalk.doc_2_0.client import Client as dingtalkdoc_2_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_2_0 import models as dingtalkdoc__2__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_2_0Client:
        """
        Initialize the account client by using a token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkdoc_2_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        doc_update_content_with_delegated_permission_headers = dingtalkdoc__2__0_models.DocUpdateContentWithDelegatedPermissionHeaders()
        doc_update_content_with_delegated_permission_headers.x_acs_dingtalk_access_token = '<your access token>'
        doc_update_content_with_delegated_permission_request = dingtalkdoc__2__0_models.DocUpdateContentWithDelegatedPermissionRequest(
            data_type='markdown',
            content='# Heading'
        )
        try:
            client.doc_update_content_with_delegated_permission_with_options('Z90D4da', doc_update_content_with_delegated_permission_request, doc_update_content_with_delegated_permission_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object 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_update_content_with_delegated_permission_headers = dingtalkdoc__2__0_models.DocUpdateContentWithDelegatedPermissionHeaders()
        doc_update_content_with_delegated_permission_headers.x_acs_dingtalk_access_token = '<your access token>'
        doc_update_content_with_delegated_permission_request = dingtalkdoc__2__0_models.DocUpdateContentWithDelegatedPermissionRequest(
            data_type='markdown',
            content='# Heading'
        )
        try:
            await client.doc_update_content_with_delegated_permission_with_options_async('Z90D4da', doc_update_content_with_delegated_permission_request, doc_update_content_with_delegated_permission_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object 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_2_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\DocUpdateContentWithDelegatedPermissionHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\DocUpdateContentWithDelegatedPermissionRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account client by using 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();
        $docUpdateContentWithDelegatedPermissionHeaders = new DocUpdateContentWithDelegatedPermissionHeaders([]);
        $docUpdateContentWithDelegatedPermissionHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $docUpdateContentWithDelegatedPermissionRequest = new DocUpdateContentWithDelegatedPermissionRequest([
            "dataType" => "markdown",
            "content" => "# Heading"
        ]);
        try {
            $client->docUpdateContentWithDelegatedPermissionWithOptions("Z90D4da", $docUpdateContentWithDelegatedPermissionRequest, $docUpdateContentWithDelegatedPermissionHeaders, 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 object 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
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkdoc_2_0  "github.com/alibabacloud-go/dingtalk/doc_2_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Initialize the account client by using a token
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkdoc_2_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkdoc_2_0.Client{}
  _result, _err = dingtalkdoc_2_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  docUpdateContentWithDelegatedPermissionHeaders := &dingtalkdoc_2_0.DocUpdateContentWithDelegatedPermissionHeaders{}
  docUpdateContentWithDelegatedPermissionHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  docUpdateContentWithDelegatedPermissionRequest := &dingtalkdoc_2_0.DocUpdateContentWithDelegatedPermissionRequest{
    DataType: tea.String("markdown"),
    Content: tea.String("# Heading"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DocUpdateContentWithDelegatedPermissionWithOptions(tea.String("Z90D4da"), docUpdateContentWithDelegatedPermissionRequest, docUpdateContentWithDelegatedPermissionHeaders, &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 object 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_2_0 = require('@alicloud/dingtalk/doc_2_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

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

  static async main(args) {
    let client = Client.createClient();
    let docUpdateContentWithDelegatedPermissionHeaders = new dingtalkdoc_2_0.DocUpdateContentWithDelegatedPermissionHeaders({ });
    docUpdateContentWithDelegatedPermissionHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let docUpdateContentWithDelegatedPermissionRequest = new dingtalkdoc_2_0.DocUpdateContentWithDelegatedPermissionRequest({
      dataType: 'markdown',
      content: '# Heading',
    });
    try {
      await client.docUpdateContentWithDelegatedPermissionWithOptions('Z90D4da', docUpdateContentWithDelegatedPermissionRequest, docUpdateContentWithDelegatedPermissionHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // The err object contains code and message attributes that help locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
C#
// 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 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Initialize the account client by using a token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkdoc_2_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_2_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.DocUpdateContentWithDelegatedPermissionHeaders docUpdateContentWithDelegatedPermissionHeaders = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.DocUpdateContentWithDelegatedPermissionHeaders();
            docUpdateContentWithDelegatedPermissionHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.DocUpdateContentWithDelegatedPermissionRequest docUpdateContentWithDelegatedPermissionRequest = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.DocUpdateContentWithDelegatedPermissionRequest
            {
                DataType = "markdown",
                Content = "# Heading",
            };
            try
            {
                client.DocUpdateContentWithDelegatedPermissionWithOptions("Z90D4da", docUpdateContentWithDelegatedPermissionRequest, docUpdateContentWithDelegatedPermissionHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err object 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))
                {
                    // The err object contains code and message attributes that help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
dataMap<String, Any>The result returned.
AnyThe result returned.

Response body example

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

{
  "data" : {
    "key" : "success:true"
  }
}

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
400paramError%sParameter error
403permissionDenied%sNo permissions
404documentNotExist%sThe document does not exist
500systemError%sThe service is busy. Try again later.
500unknownErrorUnknown ErrorUnknown error
503operationTimeout%sRequest timed out