> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Insert a block element

> Call this API to insert a block element at a specified position in a document, with request parameters and response details.

Call this API to insert a block element at a specified location.

## API call description

To learn about the data structures related to document content, see [Document data structure](/open/development/document-data-structure).

## request

### Basic information

| Field                | Value                                                                    |
| -------------------- | ------------------------------------------------------------------------ |
| HTTP URL             | `https://api.dingtalk.io/v1.0/doc/suites/documents/{docKey}/blocks`      |
| HTTP Method          | POST                                                                     |
| Supported app type   | appType-Internal app                                                     |
| Permissions required | permission-Storage.File.Write-Organization storage file write permission |

### request header

| Name                        | Type   | Required | Description                                                                                                                                                                       |
| --------------------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | Yes      | The access credential for calling this API. Obtain it by calling the [Get the access token of an internal app](/open/development/obtain-the-access-token-of-an-internal-app) API. |

### path parameter

| Name   | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ------ | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| docKey | String | Yes      | The document ID (the `docKey` or `dentryUuid` of the document). After creating a document by calling the [Create a Knowledge Base document](/open/development/create-team-space-document) API, obtain the `docKey` parameter from the response. To obtain the `dentryUuid` from the document URL, take [https://docs.dingtalk.io/i/nodes/Zxxxxa-id](https://docs.dingtalk.io/i/nodes/Zxxxxa-id) as an example. The `dentryUuid` is `Zxxxxa-id`. |

### query parameter

| Name       | Type   | Required | Description                                                                                                                       |
| ---------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------- |
| operatorId | String | Yes      | The user's unionId. Obtain the `unionid` parameter by calling the [Query user details](/open/development/query-user-details) API. |

### request body

| Name    | Type               | Required | Description                                                                                                                                                                                                                                                                                               |
| ------- | ------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| blockId | String             | No       | The unique identifier of the target block. Obtain the `blockId` parameter by calling the [Query block elements](/open/development/api-docblocksquery) API. If not specified, the `index` value is used.                                                                                                   |
| index   | Integer            | No       | When `blockId` is not provided, the `index` is used to locate the target block. The system tries to find the block at position `index` among the first-level block elements of the document, where `index` starts from 0. If not specified, the end of the document is used by default.                   |
| where   | String             | No       | Whether to insert before or after the target location. Valid values: - **after**: Insert after the target location. This is the default value. - **before**: Insert before the target location.                                                                                                           |
| element | `Map<String, Any>` | Yes      | The BlockElement type to insert and the attributes required to create the corresponding type (see [Block element data structure](/open/development/block-data-structure) for details). The structure is as follows: `{   "blockType": enum(BlockType),   [blockType]: Object(CreateElementProperties), }` |
|         | Any                | No       | Contains the element type and the information required to create the element.                                                                                                                                                                                                                             |

### Request example

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v1.0/doc/suites/documents/doc_id/blocks?operatorId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:7dc9ec4xxx
Content-Type:application/json

{
  "blockId" : "block_id",
  "index" : 1,
  "where" : "after",
  "element" : {
    "blockType" : "paragraph",
    "paragraph" : {
      "text" : "foo"
    }
  }
}
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
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.DocInsertBlocksHeaders docInsertBlocksHeaders = new com.aliyun.dingtalkdoc_1_0.models.DocInsertBlocksHeaders();
        docInsertBlocksHeaders.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.DocInsertBlocksRequest docInsertBlocksRequest = new com.aliyun.dingtalkdoc_1_0.models.DocInsertBlocksRequest()
                .setOperatorId("union_id")
                .setBlockId("block_id")
                .setIndex(1)
                .setWhere("after")
                .setElement(element);
        try {
            client.docInsertBlocksWithOptions("doc_id", docInsertBlocksRequest, docInsertBlocksHeaders, 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

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- 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()
        doc_insert_blocks_headers = dingtalkdoc__1__0_models.DocInsertBlocksHeaders()
        doc_insert_blocks_headers.x_acs_dingtalk_access_token = '<your access token>'
        element = {
            'key': {}
        }
        doc_insert_blocks_request = dingtalkdoc__1__0_models.DocInsertBlocksRequest(
            operator_id='union_id',
            block_id='block_id',
            index=1,
            where='after',
            element=element
        )
        try:
            client.doc_insert_blocks_with_options('doc_id', doc_insert_blocks_request, doc_insert_blocks_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()
        doc_insert_blocks_headers = dingtalkdoc__1__0_models.DocInsertBlocksHeaders()
        doc_insert_blocks_headers.x_acs_dingtalk_access_token = '<your access token>'
        element = {
            'key': {}
        }
        doc_insert_blocks_request = dingtalkdoc__1__0_models.DocInsertBlocksRequest(
            operator_id='union_id',
            block_id='block_id',
            index=1,
            where='after',
            element=element
        )
        try:
            await client.doc_insert_blocks_with_options_async('doc_id', doc_insert_blocks_request, doc_insert_blocks_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

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?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\DocInsertBlocksHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\DocInsertBlocksRequest;
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();
        $docInsertBlocksHeaders = new DocInsertBlocksHeaders([]);
        $docInsertBlocksHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $element = [
            "key" => []
        ];
        $docInsertBlocksRequest = new DocInsertBlocksRequest([
            "operatorId" => "union_id",
            "blockId" => "block_id",
            "index" => 1,
            "where" => "after",
            "element" => $element
        ]);
        try {
            $client->docInsertBlocksWithOptions("doc_id", $docInsertBlocksRequest, $docInsertBlocksHeaders, 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

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
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
  }

  docInsertBlocksHeaders := &dingtalkdoc_1_0.DocInsertBlocksHeaders{}
  docInsertBlocksHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  element := map[string]map[string]interface{}{
    "key": map[string]interface{}{},
  }
  docInsertBlocksRequest := &dingtalkdoc_1_0.DocInsertBlocksRequest{
    OperatorId: tea.String("union_id"),
    BlockId: tea.String("block_id"),
    Index: tea.Int32(1),
    Where: tea.String("after"),
    Element: element,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DocInsertBlocksWithOptions(tea.String("doc_id"), docInsertBlocksRequest, docInsertBlocksHeaders, &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

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
'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 docInsertBlocksHeaders = new dingtalkdoc_1_0.DocInsertBlocksHeaders({ });
    docInsertBlocksHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let element = {
      key: { },
    };
    let docInsertBlocksRequest = new dingtalkdoc_1_0.DocInsertBlocksRequest({
      operatorId: 'union_id',
      blockId: 'block_id',
      index: 1,
      where: 'after',
      element: element,
    });
    try {
      await client.docInsertBlocksWithOptions('doc_id', docInsertBlocksRequest, docInsertBlocksHeaders, 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#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
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.DocInsertBlocksHeaders docInsertBlocksHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocInsertBlocksHeaders();
            docInsertBlocksHeaders.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.DocInsertBlocksRequest docInsertBlocksRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocInsertBlocksRequest
            {
                OperatorId = "union_id",
                BlockId = "block_id",
                Index = 1,
                Where = "after",
                Element = element,
            };
            try
            {
                client.DocInsertBlocksWithOptions("doc_id", docInsertBlocksRequest, docInsertBlocksHeaders, 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

| Name    | Type               | Description                    |
| ------- | ------------------ | ------------------------------ |
| success | Boolean            | Whether the request succeeded. |
| result  | Object             | The request result.            |
| data    | `Map<String, Any>` | The inserted element.          |
|         | Any                | Details about the element.     |

### Response body example

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "success": true,
  "result": {
    "data": {
      "blockType": "paragraph",
      "paragraph": {
        "text": "foo"
      },
      "id": "lmoasis2f3wxmwyyyy",
      "index": 2,
    }
  }
}
```

### error code

If an error is returned when you call this API, find the solution in the [Global error codes](/open/development/server-api-error-codes-1) documentation based on the error message.

| HttpCode | Error code                       | Error message | Description                                                                                                                            |
| -------- | -------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| 400      | paramError                       | %s            | Parameter error.                                                                                                                       |
| 400      | invalidRequest.inputArgs.invalid | %s            | Parameter error. Refer to the error message for details.                                                                               |
| 403      | forbidden.accessDenied           | %s            | No permissions.                                                                                                                        |
| 403      | forbidden.acrossOrg              | %s            | The request is invalid. Check whether the document you are trying to access belongs to the organization specified by the access token. |
| 404      | docNotExist                      | %s            | The document does not exist.                                                                                                           |
| 404      | invalidRequest.resource.notFound | %s            | The requested resource cannot be found.                                                                                                |
| 500      | forbidden.operationIllegal       | %s            | The requested operation is invalid.                                                                                                    |
| 500      | systemError                      | %s            | The service is busy. Try again later.                                                                                                  |
| 500      | unknownError                     | Unknown Error | Unknown error.                                                                                                                         |
| 503      | operationTimeout                 | %s            | Request timed out.                                                                                                                     |