Skip to main content
Call this API to add attendees to an event.

API call description

Each attendee operation supports up to 500 people, 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
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app appType-Third-party personal app
Required permissionspermission-Calendar.Event.Write-Write permission for 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 an enterprise authorized to a third-party app API. - For a third-party personal app, call the Get the user token API.

Path parameters

NameTypeRequiredDescription
userIdStringYesThe unionId of the event creator. - For an internal app or a third-party enterprise app, call the Query user details API to obtain the unionid parameter value. - For a third-party personal app, call the Get user profile from contacts API to obtain the unionId parameter value.
calendarIdStringYesThe ID of the calendar to which the event belongs. Set it to primary to indicate the user’s primary calendar.
eventIdStringYesThe event ID. Call the Query event list API to obtain the id parameter value.

Request body

NameTypeRequiredDescription
attendeesToAddArrayYesThe list of attendees to add.
idStringNoThe unionId of the attendee. - For an internal app or a third-party enterprise app, call the Query user details API to obtain the unionid parameter value. - For a third-party personal app, call the Get user profile from contacts API to obtain the unionId parameter value.
isOptionalBooleanNoSpecifies whether the attendee is optional. - true: Yes. - false: No.
pushNotificationBooleanNoSpecifies whether to send a pop-up reminder.
chatNotificationBooleanNoSpecifies whether to send a direct message reminder.

Request example

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

{
  "attendeesToAdd" : [ {
    "id" : "iiiP35sJadba8aBSgjrwPRKgiEiF",
    "isOptional" : false
  } ]
}
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.AddAttendeeHeaders addAttendeeHeaders = new com.aliyun.dingtalkcalendar_1_0.models.AddAttendeeHeaders();
        addAttendeeHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkcalendar_1_0.models.AddAttendeeRequest.AddAttendeeRequestAttendeesToAdd attendeesToAdd0 = new com.aliyun.dingtalkcalendar_1_0.models.AddAttendeeRequest.AddAttendeeRequestAttendeesToAdd()
                .setId("iiiP35sJadba8aBSgjrwPRKgiEiF")
                .setIsOptional(false);
        com.aliyun.dingtalkcalendar_1_0.models.AddAttendeeRequest addAttendeeRequest = new com.aliyun.dingtalkcalendar_1_0.models.AddAttendeeRequest()
                .setAttendeesToAdd(java.util.Arrays.asList(
                    attendeesToAdd0
                ));
        try {
            client.addAttendeeWithOptions("U5KPwll3QjgiG", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08", addAttendeeRequest, addAttendeeHeaders, 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 help diagnose 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 help diagnose 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 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()
        add_attendee_headers = dingtalkcalendar__1__0_models.AddAttendeeHeaders()
        add_attendee_headers.x_acs_dingtalk_access_token = '<your access token>'
        attendees_to_add_0 = dingtalkcalendar__1__0_models.AddAttendeeRequestAttendeesToAdd(
            id='iiiP35sJadba8aBSgjrwPRKgiEiF',
            is_optional=False
        )
        add_attendee_request = dingtalkcalendar__1__0_models.AddAttendeeRequest(
            attendees_to_add=[
                attendees_to_add_0
            ]
        )
        try:
            client.add_attendee_with_options('U5KPwll3QjgiG', 'primary', 'cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08', add_attendee_request, add_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 attributes, which help diagnose the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        add_attendee_headers = dingtalkcalendar__1__0_models.AddAttendeeHeaders()
        add_attendee_headers.x_acs_dingtalk_access_token = '<your access token>'
        attendees_to_add_0 = dingtalkcalendar__1__0_models.AddAttendeeRequestAttendeesToAdd(
            id='iiiP35sJadba8aBSgjrwPRKgiEiF',
            is_optional=False
        )
        add_attendee_request = dingtalkcalendar__1__0_models.AddAttendeeRequest(
            attendees_to_add=[
                attendees_to_add_0
            ]
        )
        try:
            await client.add_attendee_with_options_async('U5KPwll3QjgiG', 'primary', 'cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08', add_attendee_request, add_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 attributes, which help diagnose 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\AddAttendeeHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\AddAttendeeRequest\attendeesToAdd;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\AddAttendeeRequest;
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();
        $addAttendeeHeaders = new AddAttendeeHeaders([]);
        $addAttendeeHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $attendeesToAdd0 = new attendeesToAdd([
            "id" => "iiiP35sJadba8aBSgjrwPRKgiEiF",
            "isOptional" => false
        ]);
        $addAttendeeRequest = new AddAttendeeRequest([
            "attendeesToAdd" => [
                $attendeesToAdd0
            ]
        ]);
        try {
            $client->addAttendeeWithOptions("U5KPwll3QjgiG", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08", $addAttendeeRequest, $addAttendeeHeaders, 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 help diagnose 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 (
  "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
  }

  addAttendeeHeaders := &dingtalkcalendar_1_0.AddAttendeeHeaders{}
  addAttendeeHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  attendeesToAdd0 := &dingtalkcalendar_1_0.AddAttendeeRequestAttendeesToAdd{
    Id: tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF"),
    IsOptional: tea.Bool(false),
  }
  addAttendeeRequest := &dingtalkcalendar_1_0.AddAttendeeRequest{
    AttendeesToAdd: []*dingtalkcalendar_1_0.AddAttendeeRequestAttendeesToAdd{attendeesToAdd0},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.AddAttendeeWithOptions(tea.String("U5KPwll3QjgiG"), tea.String("primary"), tea.String("cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08"), addAttendeeRequest, addAttendeeHeaders, &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 help diagnose 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 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 addAttendeeHeaders = new $dingtalkcalendar_1_0.AddAttendeeHeaders({ });
    addAttendeeHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let attendeesToAdd0 = new $dingtalkcalendar_1_0.AddAttendeeRequestAttendeesToAdd({
      id: "iiiP35sJadba8aBSgjrwPRKgiEiF",
      isOptional: false,
    });
    let addAttendeeRequest = new $dingtalkcalendar_1_0.AddAttendeeRequest({
      attendeesToAdd: [
        attendeesToAdd0
      ],
    });
    try {
      await client.addAttendeeWithOptions("U5KPwll3QjgiG", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08", addAttendeeRequest, addAttendeeHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains the code and message attributes, which help diagnose the issue
      }

    }    
  }

}

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.AddAttendeeHeaders addAttendeeHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddAttendeeHeaders();
            addAttendeeHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddAttendeeRequest.AddAttendeeRequestAttendeesToAdd attendeesToAdd0 = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddAttendeeRequest.AddAttendeeRequestAttendeesToAdd
            {
                Id = "iiiP35sJadba8aBSgjrwPRKgiEiF",
                IsOptional = false,
            };
            AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddAttendeeRequest addAttendeeRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddAttendeeRequest
            {
                AttendeesToAdd = new List<AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddAttendeeRequest.AddAttendeeRequestAttendeesToAdd>
                {
                    attendeesToAdd0
                },
            };
            try
            {
                client.AddAttendeeWithOptions("U5KPwll3QjgiG", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08", addAttendeeRequest, addAttendeeHeaders, 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 help diagnose 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 help diagnose the issue
                }
            }
        }

    }
}

Response

Response body example

HTTP/1.1 200 OK

Error codes

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