> ## 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. # Update a subscription calendar > Call this API to update information of a single subscription calendar. Documents the request parameters and response structure. Call this API to update the information of a single subscription calendar. ## Request ### Basic information | Field | Value | | -------------------- | ---------------------------------------------------------------------------------------- | | HTTP URL | `https://api.dingtalk.io/v1.0/calendar/users/{userId}/subscribedCalendars/{calendarId}` | | HTTP Method | PUT | | Supported app types | appType-Internal app　appType-Third-party enterprise app　appType-Third-party personal app | | Required permissions | permission-Calendar.Calendar.Write-Write permission for the Calendar app | ### Request headers | Name | Type | Required | Description | | --------------------------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it as follows: - For an internal app, call [Obtain the access token of an internal app](/open/development/obtain-the-access-token-of-an-internal-app#). - For a third-party enterprise app, call [Obtain the access token of an authorized enterprise for a third-party app](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#). - For a third-party personal app, call [Obtain a user token](/open/development/obtain-user-token#). | ### Path parameters | Name | Type | Required | Description | | ---------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | calendarId | String | Yes | The subscription calendar ID. Call [Create a subscription calendar](/open/development/create-subscription-calendar#) to obtain the value of the calendarId parameter. | | userId | String | Yes | The unionId of the calendar author or co-editor. - For internal apps and third-party enterprise apps, call [Query user details](/open/development/query-user-details#) to obtain the value of the unionid parameter. - For third-party personal apps, call [Obtain the profile of a Contacts user](/open/development/dingtalk-retrieve-user-information#) to obtain the value of the unionId parameter. | ### Request body | Name | Type | Required | Description | | ------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | name | String | No | The title of the subscription calendar. | | description | String | No | The description of the subscription calendar. | | managers | Array of String | No | The unionId list of the calendar co-editors. - For internal apps and third-party enterprise apps, call [Query user details](/open/development/query-user-details#) to obtain the value of the unionid parameter. - For third-party personal apps, call [Obtain the profile of a Contacts user](/open/development/dingtalk-retrieve-user-information#) to obtain the value of the unionId parameter. | | subscribeScope | Object | No | The subscription scope of the calendar. | | unionIds | Array of String | No | The unionIds of the users who can subscribe to the calendar. - For internal apps and third-party enterprise apps, call [Query user details](/open/development/query-user-details#) to obtain the value of the unionid parameter. - For third-party personal apps, call [Obtain the profile of a Contacts user](/open/development/dingtalk-retrieve-user-information#) to obtain the value of the unionId parameter. | | openConversationIds | Array of String | No | The OpenConversationId list of the groups that can subscribe to this calendar. - For an internal app, call [Obtain the OpenConversationId of a group chat](/open/development/obtain-group-openconversationid#) to obtain the value of the openConversationId parameter. - For a third-party enterprise app, call [Create a group](https://open.dingtalk.com/document/development/create-a-scene-group-v2#) to obtain the value of the open\_conversation\_id parameter. - You must pass the OpenConversationId of the group that the subscription event creator belongs to. - For a third-party personal app, this parameter is not required. | | corpIds | Array of String | No | The corpId list of the organizations that can subscribe to this calendar. Sign in to the [DingTalk Developer Console](https://open-dev.dingtalk.io/#/) and view your organization ID on the Home page. You must pass the corpId of the organization that the subscription event creator belongs to. | ### Request example HTTP ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} PUT /v1.0/calendar/users/iiiP35sJadba8aBSgjrwPRKgiEiF/subscribedCalendars/M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv HTTP/1.1 Host:api.dingtalk.io x-acs-dingtalk-access-token:cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT01 Content-Type:application/json { "name" : "Traditional Chinese Calendar", "description" : "Traditional Chinese Calendar", "managers" : [ "iiiP35sJadba8aBSgjrwPRKgiEiF" ], "subscribeScope" : { "unionIds" : [ "iiiP35sJadba8aBSgjrwPRKgiEiF" ], "openConversationIds" : [ "cidvrURjEqVe8xxxxxxx" ], "corpIds" : [ "dingz0xc7v89789asasdf" ] } } ``` Java ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it. Thanks. package com.aliyun.sample; import com.aliyun.tea.*; import com.aliyun.teautil.*; import com.aliyun.teautil.models.*; import com.aliyun.dingtalkcalendar_1_0.*; import com.aliyun.dingtalkcalendar_1_0.models.*; import com.aliyun.teaopenapi.*; import com.aliyun.teaopenapi.models.*; 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 { Config config = new 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 args = java.util.Arrays.asList(args_); com.aliyun.dingtalkcalendar_1_0.Client client = Sample.createClient(); UpdateSubscribedCalendarsHeaders updateSubscribedCalendarsHeaders = new UpdateSubscribedCalendarsHeaders(); updateSubscribedCalendarsHeaders.xAcsDingtalkAccessToken = ""; UpdateSubscribedCalendarsRequest.UpdateSubscribedCalendarsRequestSubscribeScope subscribeScope = new UpdateSubscribedCalendarsRequest.UpdateSubscribedCalendarsRequestSubscribeScope() .setUnionIds(java.util.Arrays.asList( "iiiP35sJadba8aBSgjrwPRKgiEiF" )) .setOpenConversationIds(java.util.Arrays.asList( "cidvrURjEqVe8xxxxxxx" )) .setCorpIds(java.util.Arrays.asList( "dingz0xc7v89789asasdf" )); UpdateSubscribedCalendarsRequest updateSubscribedCalendarsRequest = new UpdateSubscribedCalendarsRequest() .setName("Traditional Chinese Calendar") .setDescription("Traditional Chinese Calendar") .setManagers(java.util.Arrays.asList( "iiiP35sJadba8aBSgjrwPRKgiEiF" )) .setSubscribeScope(subscribeScope); try { client.updateSubscribedCalendarsWithOptions("M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv", "iiiP35sJadba8aBSgjrwPRKgiEiF", updateSubscribedCalendarsRequest, updateSubscribedCalendarsHeaders, new RuntimeOptions()); } catch (TeaException err) { if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) { // err contains code and message attributes 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 attributes that help 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 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() update_subscribed_calendars_headers = dingtalkcalendar__1__0_models.UpdateSubscribedCalendarsHeaders() update_subscribed_calendars_headers.x_acs_dingtalk_access_token = '' subscribe_scope = dingtalkcalendar__1__0_models.UpdateSubscribedCalendarsRequestSubscribeScope( union_ids=[ 'iiiP35sJadba8aBSgjrwPRKgiEiF' ], open_conversation_ids=[ 'cidvrURjEqVe8xxxxxxx' ], corp_ids=[ 'dingz0xc7v89789asasdf' ] ) update_subscribed_calendars_request = dingtalkcalendar__1__0_models.UpdateSubscribedCalendarsRequest( name='Traditional Chinese Calendar', description='Traditional Chinese Calendar', managers=[ 'iiiP35sJadba8aBSgjrwPRKgiEiF' ], subscribe_scope=subscribe_scope ) try: client.update_subscribed_calendars_with_options('M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv', 'iiiP35sJadba8aBSgjrwPRKgiEiF', update_subscribed_calendars_request, update_subscribed_calendars_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 attributes that help locate the issue pass @staticmethod async def main_async( args: List[str], ) -> None: client = Sample.create_client() update_subscribed_calendars_headers = dingtalkcalendar__1__0_models.UpdateSubscribedCalendarsHeaders() update_subscribed_calendars_headers.x_acs_dingtalk_access_token = '' subscribe_scope = dingtalkcalendar__1__0_models.UpdateSubscribedCalendarsRequestSubscribeScope( union_ids=[ 'iiiP35sJadba8aBSgjrwPRKgiEiF' ], open_conversation_ids=[ 'cidvrURjEqVe8xxxxxxx' ], corp_ids=[ 'dingz0xc7v89789asasdf' ] ) update_subscribed_calendars_request = dingtalkcalendar__1__0_models.UpdateSubscribedCalendarsRequest( name='Traditional Chinese Calendar', description='Traditional Chinese Calendar', managers=[ 'iiiP35sJadba8aBSgjrwPRKgiEiF' ], subscribe_scope=subscribe_scope ) try: await client.update_subscribed_calendars_with_options_async('M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv', 'iiiP35sJadba8aBSgjrwPRKgiEiF', update_subscribed_calendars_request, update_subscribed_calendars_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 attributes that help locate the issue pass if __name__ == '__main__': Sample.main(sys.argv[1:]) ``` PHP ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} protocol = "https"; $config->regionId = "central"; return new Dingtalk($config); } /** * @param string[] $args * @return void */ public static function main($args){ $client = self::createClient(); $updateSubscribedCalendarsHeaders = new UpdateSubscribedCalendarsHeaders([]); $updateSubscribedCalendarsHeaders->xAcsDingtalkAccessToken = ""; $subscribeScope = new subscribeScope([ "unionIds" => [ "iiiP35sJadba8aBSgjrwPRKgiEiF" ], "openConversationIds" => [ "cidvrURjEqVe8xxxxxxx" ], "corpIds" => [ "dingz0xc7v89789asasdf" ] ]); $updateSubscribedCalendarsRequest = new UpdateSubscribedCalendarsRequest([ "name" => "Traditional Chinese Calendar", "description" => "Traditional Chinese Calendar", "managers" => [ "iiiP35sJadba8aBSgjrwPRKgiEiF" ], "subscribeScope" => $subscribeScope ]); try { $client->updateSubscribedCalendarsWithOptions("M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv", "iiiP35sJadba8aBSgjrwPRKgiEiF", $updateSubscribedCalendarsRequest, $updateSubscribedCalendarsHeaders, 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 attributes 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)); ``` Go ```go theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it. Thanks. package main import ( "os" util "github.com/alibabacloud-go/tea-utils/service" dingtalkcalendar_1_0 "github.com/alibabacloud-go/dingtalk/calendar_1_0" openapi "github.com/alibabacloud-go/darabonba-openapi/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 } updateSubscribedCalendarsHeaders := &dingtalkcalendar_1_0.UpdateSubscribedCalendarsHeaders{} updateSubscribedCalendarsHeaders.XAcsDingtalkAccessToken = tea.String("") subscribeScope := &dingtalkcalendar_1_0.UpdateSubscribedCalendarsRequestSubscribeScope{ UnionIds: []*string{tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF")}, OpenConversationIds: []*string{tea.String("cidvrURjEqVe8xxxxxxx")}, CorpIds: []*string{tea.String("dingz0xc7v89789asasdf")}, } updateSubscribedCalendarsRequest := &dingtalkcalendar_1_0.UpdateSubscribedCalendarsRequest{ Name: tea.String("Traditional Chinese Calendar"), Description: tea.String("Traditional Chinese Calendar"), Managers: []*string{tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF")}, SubscribeScope: subscribeScope, } tryErr := func()(_e error) { defer func() { if r := tea.Recover(recover()); r != nil { _e = r } }() _, _err = client.UpdateSubscribedCalendarsWithOptions(tea.String("M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv"), tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF"), updateSubscribedCalendarsRequest, updateSubscribedCalendarsHeaders, &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 attributes that help locate the issue } } return _err } func main() { err := _main(tea.StringSlice(os.Args[1:])) if err != nil { panic(err) } } ``` Node.js ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} // 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 { let client = Client.createClient(); let updateSubscribedCalendarsHeaders = new $dingtalkcalendar_1_0.UpdateSubscribedCalendarsHeaders({ }); updateSubscribedCalendarsHeaders.xAcsDingtalkAccessToken = ""; let subscribeScope = new $dingtalkcalendar_1_0.UpdateSubscribedCalendarsRequestSubscribeScope({ unionIds: [ "iiiP35sJadba8aBSgjrwPRKgiEiF" ], openConversationIds: [ "cidvrURjEqVe8xxxxxxx" ], corpIds: [ "dingz0xc7v89789asasdf" ], }); let updateSubscribedCalendarsRequest = new $dingtalkcalendar_1_0.UpdateSubscribedCalendarsRequest({ name: "Traditional Chinese Calendar", description: "Traditional Chinese Calendar", managers: [ "iiiP35sJadba8aBSgjrwPRKgiEiF" ], subscribeScope: subscribeScope, }); try { await client.updateSubscribedCalendarsWithOptions("M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv", "iiiP35sJadba8aBSgjrwPRKgiEiF", updateSubscribedCalendarsRequest, updateSubscribedCalendarsHeaders, new $Util.RuntimeOptions({ })); } catch (err) { if (!Util.empty(err.code) && !Util.empty(err.message)) { // err contains code and message attributes that help locate the issue } } } } Client.main(process.argv.slice(2)); ``` C# ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // 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.UpdateSubscribedCalendarsHeaders updateSubscribedCalendarsHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.UpdateSubscribedCalendarsHeaders(); updateSubscribedCalendarsHeaders.XAcsDingtalkAccessToken = ""; AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.UpdateSubscribedCalendarsRequest.UpdateSubscribedCalendarsRequestSubscribeScope subscribeScope = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.UpdateSubscribedCalendarsRequest.UpdateSubscribedCalendarsRequestSubscribeScope { UnionIds = new List { "iiiP35sJadba8aBSgjrwPRKgiEiF" }, OpenConversationIds = new List { "cidvrURjEqVe8xxxxxxx" }, CorpIds = new List { "dingz0xc7v89789asasdf" }, }; AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.UpdateSubscribedCalendarsRequest updateSubscribedCalendarsRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.UpdateSubscribedCalendarsRequest { Name = "Traditional Chinese Calendar", Description = "Traditional Chinese Calendar", Managers = new List { "iiiP35sJadba8aBSgjrwPRKgiEiF" }, SubscribeScope = subscribeScope, }; try { client.UpdateSubscribedCalendarsWithOptions("M5MjkxNDUxQHVzZXJzLmRpbmd0YWxrLmNv", "iiiP35sJadba8aBSgjrwPRKgiEiF", updateSubscribedCalendarsRequest, updateSubscribedCalendarsHeaders, 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 attributes that help locate the issue } } catch (Exception _err) { TeaException err = new TeaException(new Dictionary { { "message", _err.Message } }); if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err contains code and message attributes that help locate the issue } } } } } ``` ## Response ### Response body | Name | Type | Description | | ------ | ------- | ------------------------------------------------------- | | result | Boolean | Whether the API call succeeded. true indicates success. | ### Response body example ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} HTTP/1.1 200 OK Content-Type:application/json { "result" : true } ``` ### Error codes If an error is returned when calling this API, find the solution in the [Global error codes](/open/development/server-api-error-codes-1) document based on the error message. | HttpCode | Error code | Error message | Description | | -------- | ---------------- | --------------------------------------- | -------------------------------------------------------------------- | | 400 | invalidParameter | forwardErrorMessage | Parameter error | | 400 | invalidParameter | calendar id cannot be blank | The calendar ID cannot be empty | | 400 | invalidParameter | calendar name length must less than 128 | The calendar name cannot exceed 128 characters | | 400 | invalidParameter | subscribe range cannot be null | The subscription scope cannot be empty | | 400 | invalidParameter | calendar name cannot be blank | The calendar name cannot be empty | | 400 | invalidParameter | current user must in range | The current user must be in the corresponding group and organization | | 403 | permissionDenied | permission denied | Authentication failed |