Delete Event

Call this API to delete a specified event.

API call description

When the organizer deletes the event (the URL contains the organizer’s unionId), all attendees receive an event cancellation notification, and the event is removed from all attendees’ calendars.
When an attendee deletes the event (the URL contains the attendee’s unionId), the event is removed only from that attendee’s calendar; other event attendees are not affected.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/calendar/users/{userId}/calendars/{calendarId}/events/{eventId}`
HTTP Method	DELETE
Supported app types	appType-Internal app　appType-Third-party enterprise app　appType-Third-party personal app
Required permissions	permission-Calendar.Event.Write-Write permission for events in the Calendar app

Request headers

Name	Type	Required	Description
x-client-token	String	No	Idempotency check. - Requests with the same `x-client-token` are treated as the same request. - Expires in 1 day.
x-acs-dingtalk-access-token	String	Yes	The access credential for calling this API. Obtain it as follows: - For an internal app, call the Obtain the access token of an internal app API. - For a third-party enterprise app, call the Obtain the access token of an authorized enterprise for a third-party app API. - For a third-party personal app, call the Obtain a user token API.

Path parameters

Name	Type	Required	Description
userId	String	Yes	The unionId of the user the event to be deleted belongs to. - For internal apps and third-party enterprise apps, call the Query user details API to obtain the `unionid` value. - For third-party personal apps, call the Obtain user profile from Contacts API to obtain the `unionId` value.
calendarId	String	Yes	The ID of the calendar the event belongs to. Set to `primary`, which represents the user’s primary calendar.
eventId	String	Yes	The event ID. Call the New Event API or the Query event list API to obtain the `id` value.

Query parameters

Name	Type	Required	Description
pushNotification	Boolean	No	Whether to display a pop-up reminder. - true: Yes - false: No

Request example

HTTP

DELETE /v1.0/calendar/users/iiiP35sJadba8aBSgjrwPRKgiEiF/calendars/primary/events/cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09?pushNotification=true HTTP/1.1
Host:api.dingtalk.io
x-client-token:******
x-acs-dingtalk-access-token:dd43888e26953deead8cba556389b064
Content-Type:application/json

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 using 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.DeleteEventHeaders deleteEventHeaders = new com.aliyun.dingtalkcalendar_1_0.models.DeleteEventHeaders();
        deleteEventHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkcalendar_1_0.models.DeleteEventRequest deleteEventRequest = new com.aliyun.dingtalkcalendar_1_0.models.DeleteEventRequest()
                .setPushNotification(true);
        try {
            client.deleteEventWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09", deleteEventRequest, deleteEventHeaders, 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 code and message properties 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)) {
                // err contains code and message properties 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.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 using 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()
        delete_event_headers = dingtalkcalendar__1__0_models.DeleteEventHeaders()
        delete_event_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_event_request = dingtalkcalendar__1__0_models.DeleteEventRequest(
            push_notification=True
        )
        try:
            client.delete_event_with_options('iiiP35sJadba8aBSgjrwPRKgiEiF', 'primary', 'cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09', delete_event_request, delete_event_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties that help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        delete_event_headers = dingtalkcalendar__1__0_models.DeleteEventHeaders()
        delete_event_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_event_request = dingtalkcalendar__1__0_models.DeleteEventRequest(
            push_notification=True
        )
        try:
            await client.delete_event_with_options_async('iiiP35sJadba8aBSgjrwPRKgiEiF', 'primary', 'cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09', delete_event_request, delete_event_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties 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\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\DeleteEventHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\DeleteEventRequest;
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();
        $deleteEventHeaders = new DeleteEventHeaders([]);
        $deleteEventHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $deleteEventRequest = new DeleteEventRequest([
            "pushNotification" => true
        ]);
        try {
            $client->deleteEventWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09", $deleteEventRequest, $deleteEventHeaders, 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 code and message properties 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));

// 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 using 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
  }

  deleteEventHeaders := &dingtalkcalendar_1_0.DeleteEventHeaders{}
  deleteEventHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  deleteEventRequest := &dingtalkcalendar_1_0.DeleteEventRequest{
    PushNotification: tea.Bool(true),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DeleteEventWithOptions(tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF"), tea.String("primary"), tea.String("cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09"), deleteEventRequest, deleteEventHeaders, &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 code and message properties that help locate the issue
    }

  }
  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 using 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 deleteEventHeaders = new $dingtalkcalendar_1_0.DeleteEventHeaders({ });
    deleteEventHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let deleteEventRequest = new $dingtalkcalendar_1_0.DeleteEventRequest({
      pushNotification: true,
    });
    try {
      await client.deleteEventWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09", deleteEventRequest, deleteEventHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message properties that help locate the issue
      }

    }    
  }

}

Client.main(process.argv.slice(2));

// 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 using 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.DeleteEventHeaders deleteEventHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.DeleteEventHeaders();
            deleteEventHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.DeleteEventRequest deleteEventRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.DeleteEventRequest
            {
                PushNotification = true,
            };
            try
            {
                client.DeleteEventWithOptions("iiiP35sJadba8aBSgjrwPRKgiEiF", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT09", deleteEventRequest, deleteEventHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties 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))
                {
                    // err contains code and message properties that help locate the issue
                }
            }
        }

    }
}

Response

Response body example

HTTP/1.1 200 OK

Error codes

If the API call returns an error, look up the solution in the Global error codes document based on the error message.

HttpCode	Error code	Error message	Description
400	invalidParameter	forwardErrorMessage	Invalid parameter
400	idempotencyProcessing	Idempotency processing	The idempotent request is being processed
404	itemNotFound	forwardErrorMessage	The specified event cannot be found

API calling guide

Authentication & authorization

Contacts

Calendar

Conferencing

AI Table

Docs & files

IM

API call description

Request

Basic information

Request headers

Path parameters

Query parameters

Request example

Response

Response body example

Error codes

​API call description

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request example

​Response

​Response body example

​Error codes

API call description

Request

Basic information

Request headers

Path parameters

Query parameters

Request example

Response

Response body example

Error codes