Skip to main content
Call this API to update the attributes of an existing floating image in a DingTalk Spreadsheet, including the image source, anchor position, and size offsets. Partial updates are supported—fields that are not provided retain their original values. For example, pass only anchor to adjust the image position without affecting other attributes. This API is suitable for adjusting the image position, replacing the image source, or modifying the display size. After a successful call, the complete attributes of the updated image are returned.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/floatImages/{id}
HTTP MethodPUT
Supported app typeappType-Internal app
Permissions requiredpermission-Document.Workbook.Write-DingTalk Spreadsheet write permission

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Call the Get the access token of an internal app API to obtain it.

Path parameters

NameTypeRequiredDescription
workbookIdStringYesThe ID of the Spreadsheet file. The nodeId(dentryUuid) returned by the Knowledge Base API is the Spreadsheet workbookId. Obtain it by calling the Get a node or Create a Knowledge Base document API.
sheetIdStringYesThe ID or title of the Worksheet. Call the Get all worksheets API to obtain the ID and title of the Worksheet.
idStringYesThe specified floating image ID. Obtain it through the “Query floating images” API.

Query parameters

NameTypeRequiredDescription
operatorIdStringYesThe unionId of the operator. Call the Query user details API to obtain it. If the operator does not have permission, the API returns the error The operator has no permission.

Request body

NameTypeRequiredDescription
srcStringNoThe resource address of the floating image. Call the Get resource upload information API to obtain resourceUrl.
anchorObjectNoThe anchor position that specifies the Cell where the image is anchored.
rowIntegerNoThe row number of the anchor (starting from 0).
colIntegerNoThe column number of the anchor (starting from 0).
coordinateObjectNoThe image size and the offset relative to the anchor Cell.
widthdoubleNoThe image width, in pixels.
heightdoubleNoThe image height, in pixels.
offsetXdoubleNoThe horizontal offset relative to the top-left corner of the anchor Cell, in pixels.
offsetYdoubleNoThe vertical offset relative to the top-left corner of the anchor Cell, in pixels.

Request example

HTTP
PUT /v1.0/doc/workbooks/xxx/sheets/xxx/floatImages/xxx?operatorId=xxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxx
Content-Type:application/json

{
  "src" : "/core/api/resources/img/xxx",
  "anchor" : {
    "row" : 0,
    "col" : 0
  },
  "coordinate" : {
    "width" : 300.0,
    "height" : 300.0,
    "offsetX" : 8.0,
    "offsetY" : 8.0
  }
}
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.UpdateFloatImageHeaders updateFloatImageHeaders = new com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageHeaders();
        updateFloatImageHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest.UpdateFloatImageRequestCoordinate coordinate = new com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest.UpdateFloatImageRequestCoordinate()
                .setWidth(300D)
                .setHeight(300D)
                .setOffsetX(8D)
                .setOffsetY(8D);
        com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest.UpdateFloatImageRequestAnchor anchor = new com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest.UpdateFloatImageRequestAnchor()
                .setRow(0)
                .setCol(0);
        com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest updateFloatImageRequest = new com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest()
                .setOperatorId("xxx")
                .setSrc("/core/api/resources/img/xxx")
                .setAnchor(anchor)
                .setCoordinate(coordinate);
        try {
            client.updateFloatImageWithOptions("xxx", "xxx", "xxx", updateFloatImageRequest, updateFloatImageHeaders, 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 the 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 object contains the 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 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()
        update_float_image_headers = dingtalkdoc__1__0_models.UpdateFloatImageHeaders()
        update_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
        coordinate = dingtalkdoc__1__0_models.UpdateFloatImageRequestCoordinate(
            width=300,
            height=300,
            offset_x=8,
            offset_y=8
        )
        anchor = dingtalkdoc__1__0_models.UpdateFloatImageRequestAnchor(
            row=0,
            col=0
        )
        update_float_image_request = dingtalkdoc__1__0_models.UpdateFloatImageRequest(
            operator_id='xxx',
            src='/core/api/resources/img/xxx',
            anchor=anchor,
            coordinate=coordinate
        )
        try:
            client.update_float_image_with_options('xxx', 'xxx', 'xxx', update_float_image_request, update_float_image_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains the code and message attributes, which help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_float_image_headers = dingtalkdoc__1__0_models.UpdateFloatImageHeaders()
        update_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
        coordinate = dingtalkdoc__1__0_models.UpdateFloatImageRequestCoordinate(
            width=300,
            height=300,
            offset_x=8,
            offset_y=8
        )
        anchor = dingtalkdoc__1__0_models.UpdateFloatImageRequestAnchor(
            row=0,
            col=0
        )
        update_float_image_request = dingtalkdoc__1__0_models.UpdateFloatImageRequest(
            operator_id='xxx',
            src='/core/api/resources/img/xxx',
            anchor=anchor,
            coordinate=coordinate
        )
        try:
            await client.update_float_image_with_options_async('xxx', 'xxx', 'xxx', update_float_image_request, update_float_image_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains the 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\UpdateFloatImageHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateFloatImageRequest\coordinate;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateFloatImageRequest\anchor;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateFloatImageRequest;
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();
        $updateFloatImageHeaders = new UpdateFloatImageHeaders([]);
        $updateFloatImageHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $coordinate = new coordinate([
            "width" => 300,
            "height" => 300,
            "offsetX" => 8,
            "offsetY" => 8
        ]);
        $anchor = new anchor([
            "row" => 0,
            "col" => 0
        ]);
        $updateFloatImageRequest = new UpdateFloatImageRequest([
            "operatorId" => "xxx",
            "src" => "/core/api/resources/img/xxx",
            "anchor" => $anchor,
            "coordinate" => $coordinate
        ]);
        try {
            $client->updateFloatImageWithOptions("xxx", "xxx", "xxx", $updateFloatImageRequest, $updateFloatImageHeaders, 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 the 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 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
  }

  updateFloatImageHeaders := &dingtalkdoc_1_0.UpdateFloatImageHeaders{}
  updateFloatImageHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  coordinate := &dingtalkdoc_1_0.UpdateFloatImageRequestCoordinate{
    Width: tea.Float64(300),
    Height: tea.Float64(300),
    OffsetX: tea.Float64(8),
    OffsetY: tea.Float64(8),
  }
  anchor := &dingtalkdoc_1_0.UpdateFloatImageRequestAnchor{
    Row: tea.Int32(0),
    Col: tea.Int32(0),
  }
  updateFloatImageRequest := &dingtalkdoc_1_0.UpdateFloatImageRequest{
    OperatorId: tea.String("xxx"),
    Src: tea.String("/core/api/resources/img/xxx"),
    Anchor: anchor,
    Coordinate: coordinate,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateFloatImageWithOptions(tea.String("xxx"), tea.String("xxx"), tea.String("xxx"), updateFloatImageRequest, updateFloatImageHeaders, &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 the 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 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 updateFloatImageHeaders = new dingtalkdoc_1_0.UpdateFloatImageHeaders({ });
    updateFloatImageHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let coordinate = new dingtalkdoc_1_0.UpdateFloatImageRequestCoordinate({
      width: 300,
      height: 300,
      offsetX: 8,
      offsetY: 8,
    });
    let anchor = new dingtalkdoc_1_0.UpdateFloatImageRequestAnchor({
      row: 0,
      col: 0,
    });
    let updateFloatImageRequest = new dingtalkdoc_1_0.UpdateFloatImageRequest({
      operatorId: 'xxx',
      src: '/core/api/resources/img/xxx',
      anchor: anchor,
      coordinate: coordinate,
    });
    try {
      await client.updateFloatImageWithOptions('xxx', 'xxx', 'xxx', updateFloatImageRequest, updateFloatImageHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // The err object contains the 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 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.UpdateFloatImageHeaders updateFloatImageHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageHeaders();
            updateFloatImageHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest.UpdateFloatImageRequestCoordinate coordinate = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest.UpdateFloatImageRequestCoordinate
            {
                Width = 300,
                Height = 300,
                OffsetX = 8,
                OffsetY = 8,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest.UpdateFloatImageRequestAnchor anchor = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest.UpdateFloatImageRequestAnchor
            {
                Row = 0,
                Col = 0,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest updateFloatImageRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest
            {
                OperatorId = "xxx",
                Src = "/core/api/resources/img/xxx",
                Anchor = anchor,
                Coordinate = coordinate,
            };
            try
            {
                client.UpdateFloatImageWithOptions("xxx", "xxx", "xxx", updateFloatImageRequest, updateFloatImageHeaders, 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 the 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 object contains the code and message attributes, which help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
resultObjectThe result after the update.
idStringThe unique identifier of the floating image.
srcStringThe resource address of the image.
anchorObjectThe anchor position that specifies the Cell where the image is anchored.
rowIntegerThe row number of the anchor (starting from 0).
colIntegerThe column number of the anchor (starting from 0).
coordinateObjectThe image size and the offset relative to the anchor Cell.
widthdoubleThe image width, in pixels.
heightdoubleThe image height, in pixels.
offsetXdoubleThe horizontal offset relative to the top-left corner of the anchor Cell, in pixels.
offsetYdoubleThe vertical offset relative to the top-left corner of the anchor Cell, in pixels.
successBooleanThe success status.

Response body example

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

{
  "result" : {
    "id" : "xxx",
    "src" : "/core/api/xxx",
    "anchor" : {
      "row" : 0,
      "col" : 0
    },
    "coordinate" : {
      "width" : 300,
      "height" : 300,
      "offsetX" : 8,
      "offsetY" : 8
    }
  },
  "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
400invalidRequest.inputArgs.invalid%sThe request parameter is invalid. Check the error message.
400invalidRequest.inputArgs.workbookIdIllegalThe workbookId is illegal.The workbookId is invalid.
400invalidRequest.resource.notWorkbook%sUnsupported document type. Check the workbookId.
403forbidden.accessDeniedThe operator has no permission.The current User does not have permission for this Action.
403forbidden.acrossOrg%sThe requested Action is invalid. Check the error message.
403forbidden.document.sizeOverLimitThe document size is over limit and the server is unable to complete your request. Retry is unlikely to work unless the document size is decreased.The Spreadsheet content is too large. Try reducing the Spreadsheet content.
404invalidRequest.resource.notFound%sThe request Failed. The requested resource cannot be found.
500internalErrorThe server encountered an internal error and was unable to complete your request. Please try again later.Internal service Error. Try again Later.
500serviceBusyThe server is busy and unable to complete your request. Please try again later.The service is busy. Try again Later.