Skip to main content
Call this API to remove specified users from the attendees of an event.

API call description

Each attendee operation supports up to 500 users at a time, and supports events with up to 5,000 attendees.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/calendar/users/{userId}/calendars/{calendarId}/events/{eventId}/attendees/batchRemove
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app appType-Third-party personal app
Required permissionspermission-Calendar.Event.Write-Write permission on events in the Calendar app

Request headers

NameTypeRequiredDescription
x-client-tokenStringNoIdempotency check. - The same x-client-token indicates the same request. - Expires after 1 day.
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of the authorized enterprise API. - For a third-party personal app, call the Get the user token API.

Path parameters

NameTypeRequiredDescription
userIdStringYesThe unionId of the event creator. - For internal apps and third-party enterprise apps, call the Query user details API to obtain the value of the unionid parameter. - For third-party personal apps, call the Get the user profile from Contacts API to obtain the value of the unionId parameter.
calendarIdStringYesThe ID of the calendar to which the event belongs. Set to primary, which represents the user’s primary calendar.
eventIdStringYesThe event ID. Call the Query the event list API to obtain the value of the id parameter.

Request body

NameTypeRequiredDescription
attendeesToRemoveArrayNoThe list of event attendees to remove.
idStringNoThe user unionId. - For internal apps and third-party enterprise apps, call the Query user details API to obtain the value of the unionid parameter. - For third-party personal apps, call the Get the user profile from Contacts API to obtain the value of the unionId parameter.

Request example

HTTP
POST /v1.0/calendar/users/iiiP35sJadba8aBSgjrwPRKgiEiF/calendars/primary/events/cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09/attendees/batchRemove HTTP/1.1
Host:api.dingtalk.io
x-client-token:******
x-acs-dingtalk-access-token:dd43888e26953deead8cba556389b064
Content-Type:application/json

{
  "attendeesToRemove" : [ {
    "id" : "iiiP35sJadba8aBSgjrwPRKgiEiF"
  } ]
}
Java
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Initialize the account Client with a Token
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkcalendar_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.dingtalkcalendar_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkcalendar_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkcalendar_1_0.models.RemoveAttendeeHeaders removeAttendeeHeaders = new com.aliyun.dingtalkcalendar_1_0.models.RemoveAttendeeHeaders();
        removeAttendeeHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkcalendar_1_0.models.RemoveAttendeeRequest.RemoveAttendeeRequestAttendeesToRemove attendeesToRemove0 = new com.aliyun.dingtalkcalendar_1_0.models.RemoveAttendeeRequest.RemoveAttendeeRequestAttendeesToRemove()
                .setId("iiiP35sJadba8aBSgjrwPRKgiEiF");
        com.aliyun.dingtalkcalendar_1_0.models.RemoveAttendeeRequest removeAttendeeRequest = new com.aliyun.dingtalkcalendar_1_0.models.RemoveAttendeeRequest()
                .setAttendeesToRemove(java.util.Arrays.asList(
                    attendeesToRemove0
                ));
        try {
            client.removeAttendeeWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09", removeAttendeeRequest, removeAttendeeHeaders, 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 properties, which help locate issues
            }

        } 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 properties, which help locate issues
            }

        }        
    }
}
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.calendar_1_0.client import Client as dingtalkcalendar_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.calendar_1_0 import models as dingtalkcalendar__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() -> dingtalkcalendar_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 dingtalkcalendar_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        remove_attendee_headers = dingtalkcalendar__1__0_models.RemoveAttendeeHeaders()
        remove_attendee_headers.x_acs_dingtalk_access_token = '<your access token>'
        attendees_to_remove_0 = dingtalkcalendar__1__0_models.RemoveAttendeeRequestAttendeesToRemove(
            id='iiiP35sJadba8aBSgjrwPRKgiEiF'
        )
        remove_attendee_request = dingtalkcalendar__1__0_models.RemoveAttendeeRequest(
            attendees_to_remove=[
                attendees_to_remove_0
            ]
        )
        try:
            client.remove_attendee_with_options('iiiP35sJadba8aBSgjrwPRKgiEiF', 'primary', 'cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09', remove_attendee_request, remove_attendee_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 properties, which help locate issues
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        remove_attendee_headers = dingtalkcalendar__1__0_models.RemoveAttendeeHeaders()
        remove_attendee_headers.x_acs_dingtalk_access_token = '<your access token>'
        attendees_to_remove_0 = dingtalkcalendar__1__0_models.RemoveAttendeeRequestAttendeesToRemove(
            id='iiiP35sJadba8aBSgjrwPRKgiEiF'
        )
        remove_attendee_request = dingtalkcalendar__1__0_models.RemoveAttendeeRequest(
            attendees_to_remove=[
                attendees_to_remove_0
            ]
        )
        try:
            await client.remove_attendee_with_options_async('iiiP35sJadba8aBSgjrwPRKgiEiF', 'primary', 'cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09', remove_attendee_request, remove_attendee_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 properties, which help locate issues
                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\Vcalendar_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\RemoveAttendeeHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\RemoveAttendeeRequest\attendeesToRemove;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\RemoveAttendeeRequest;
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();
        $removeAttendeeHeaders = new RemoveAttendeeHeaders([]);
        $removeAttendeeHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $attendeesToRemove0 = new attendeesToRemove([
            "id" => "iiiP35sJadba8aBSgjrwPRKgiEiF"
        ]);
        $removeAttendeeRequest = new RemoveAttendeeRequest([
            "attendeesToRemove" => [
                $attendeesToRemove0
            ]
        ]);
        try {
            $client->removeAttendeeWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09", $removeAttendeeRequest, $removeAttendeeHeaders, 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 properties, which help locate issues
            }
        }
    }
}
$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 (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkcalendar_1_0  "github.com/alibabacloud-go/dingtalk/calendar_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

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

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

  removeAttendeeHeaders := &dingtalkcalendar_1_0.RemoveAttendeeHeaders{}
  removeAttendeeHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  attendeesToRemove0 := &dingtalkcalendar_1_0.RemoveAttendeeRequestAttendeesToRemove{
    Id: tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF"),
  }
  removeAttendeeRequest := &dingtalkcalendar_1_0.RemoveAttendeeRequest{
    AttendeesToRemove: []*dingtalkcalendar_1_0.RemoveAttendeeRequestAttendeesToRemove{attendeesToRemove0},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.RemoveAttendeeWithOptions(tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF"), tea.String("primary"), tea.String("cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09"), removeAttendeeRequest, removeAttendeeHeaders, &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 properties, which help locate issues
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkcalendar_1_0, * as $dingtalkcalendar_1_0 from '@alicloud/dingtalk/calendar_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

  /**
   * Initialize the account Client with a Token
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkcalendar_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkcalendar_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let removeAttendeeHeaders = new $dingtalkcalendar_1_0.RemoveAttendeeHeaders({ });
    removeAttendeeHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let attendeesToRemove0 = new $dingtalkcalendar_1_0.RemoveAttendeeRequestAttendeesToRemove({
      id: "iiiP35sJadba8aBSgjrwPRKgiEiF",
    });
    let removeAttendeeRequest = new $dingtalkcalendar_1_0.RemoveAttendeeRequest({
      attendeesToRemove: [
        attendeesToRemove0
      ],
    });
    try {
      await client.removeAttendeeWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09", removeAttendeeRequest, removeAttendeeHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains the code and message properties, which help locate issues
      }

    }    
  }

}

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 
    {

        /**
         * Initialize the account Client with a Token
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.RemoveAttendeeHeaders removeAttendeeHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.RemoveAttendeeHeaders();
            removeAttendeeHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.RemoveAttendeeRequest.RemoveAttendeeRequestAttendeesToRemove attendeesToRemove0 = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.RemoveAttendeeRequest.RemoveAttendeeRequestAttendeesToRemove
            {
                Id = "iiiP35sJadba8aBSgjrwPRKgiEiF",
            };
            AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.RemoveAttendeeRequest removeAttendeeRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.RemoveAttendeeRequest
            {
                AttendeesToRemove = new List<AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.RemoveAttendeeRequest.RemoveAttendeeRequestAttendeesToRemove>
                {
                    attendeesToRemove0
                },
            };
            try
            {
                client.RemoveAttendeeWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09", removeAttendeeRequest, removeAttendeeHeaders, 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 properties, which help locate issues
                }
            }
            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 properties, which help locate issues
                }
            }
        }

    }
}

Response

Response body example

HTTP/1.1 200 OK

Error codes

If an error is returned when you call this API, find the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400invalidParameterforwardErrorMessageInvalid parameter
400idempotencyProcessingIdempotency processingThe idempotent request is being processed
404itemNotFoundforwardErrorMessageThe specified event cannot be found