> ## 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.

# Unsubscribe from file change events

> Call this API to unsubscribe from file change event subscriptions for an organization or a specified storage space, after which file change events in scope are no longer pushed.

Call this API to unsubscribe from event subscriptions for an organization or a specified storage space. After unsubscription, file change events within the corresponding scope will no longer be pushed.

## Request

### Basic information

| Field                | Value                                                                                                              |
| -------------------- | ------------------------------------------------------------------------------------------------------------------ |
| HTTP URL             | [https://api.dingtalk.io/v1.0/storage/events/unsubscribe](https://api.dingtalk.io/v1.0/storage/events/unsubscribe) |
| HTTP Method          | POST                                                                                                               |
| Supported app types  | appType-Internal app　appType-Third-party enterprise app                                                            |
| Required permissions | permission-Storage.Event.Write-Write permission for organization storage file change event subscriptions           |

### 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 the [Get the access token of an internal app](/open/development/obtain-the-access-token-of-an-internal-app#) API. - For a third-party enterprise app, call the [Get the access token of an organization authorized to a third-party app](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#) API. |

### Query parameters

| Name    | Type   | Required | Description                                                                                                         |
| ------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------- |
| unionId | String | Yes      | The unionId of the operator. Call the [Query user details](/open/development/query-user-details#) API to obtain it. |

### Request body

| Name    | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                                          |
| ------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| scopeId | String | Yes      | The ID corresponding to the subscription scope.   - When the scope parameter value is ORG, scopeId corresponds to the organization ID (corpId). See [Basic concepts - CorpId](/open/dingstart/basic-concepts-beta#section-bbk-mv0-oxd). - When scope is SPACE, scopeId corresponds to the storage space ID. Call the [Add space](/open/development/add-space#) API to obtain the id. |
| scope   | String | Yes      | The subscription scope.   - ORG: Organization - SPACE: Space                                                                                                                                                                                                                                                                                                                         |

### Request example

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v1.0/storage/events/unsubscribe?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "scopeId" : "SPACE",
  "scope" : "SPACE"
}
```

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.*;

public class Sample {

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

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkstorage_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkstorage_1_0.models.UnsubscribeEventHeaders unsubscribeEventHeaders = new com.aliyun.dingtalkstorage_1_0.models.UnsubscribeEventHeaders();
        unsubscribeEventHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.UnsubscribeEventRequest unsubscribeEventRequest = new com.aliyun.dingtalkstorage_1_0.models.UnsubscribeEventRequest()
                .setUnionId("chyxxxxx")
                .setScopeId("SPACE")
                .setScope("SPACE");
        try {
            client.unsubscribeEventWithOptions(unsubscribeEventRequest, unsubscribeEventHeaders, 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 contains the code and message attributes to 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 contains the code and message attributes to 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.storage_1_0.client import Client as dingtalkstorage_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.storage_1_0 import models as dingtalkstorage__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() -> dingtalkstorage_1_0Client:
        """
        Initialize the account Client using a Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkstorage_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        unsubscribe_event_headers = dingtalkstorage__1__0_models.UnsubscribeEventHeaders()
        unsubscribe_event_headers.x_acs_dingtalk_access_token = '<your access token>'
        unsubscribe_event_request = dingtalkstorage__1__0_models.UnsubscribeEventRequest(
            union_id='chyxxxxx',
            scope_id='SPACE',
            scope='SPACE'
        )
        try:
            client.unsubscribe_event_with_options(unsubscribe_event_request, unsubscribe_event_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains the code and message attributes to help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        unsubscribe_event_headers = dingtalkstorage__1__0_models.UnsubscribeEventHeaders()
        unsubscribe_event_headers.x_acs_dingtalk_access_token = '<your access token>'
        unsubscribe_event_request = dingtalkstorage__1__0_models.UnsubscribeEventRequest(
            union_id='chyxxxxx',
            scope_id='SPACE',
            scope='SPACE'
        )
        try:
            await client.unsubscribe_event_with_options_async(unsubscribe_event_request, unsubscribe_event_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains the code and message attributes to help locate the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
```

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\UnsubscribeEventHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\UnsubscribeEventRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $unsubscribeEventHeaders = new UnsubscribeEventHeaders([]);
        $unsubscribeEventHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $unsubscribeEventRequest = new UnsubscribeEventRequest([
            "unionId" => "chyxxxxx",
            "scopeId" => "SPACE",
            "scope" => "SPACE"
        ]);
        try {
            $client->unsubscribeEventWithOptions($unsubscribeEventRequest, $unsubscribeEventHeaders, 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 contains the code and message attributes to 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/v2/service"
  dingtalkstorage_1_0  "github.com/alibabacloud-go/dingtalk/storage_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

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

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

  unsubscribeEventHeaders := &dingtalkstorage_1_0.UnsubscribeEventHeaders{}
  unsubscribeEventHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  unsubscribeEventRequest := &dingtalkstorage_1_0.UnsubscribeEventRequest{
    UnionId: tea.String("chyxxxxx"),
    ScopeId: tea.String("SPACE"),
    Scope: tea.String("SPACE"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UnsubscribeEventWithOptions(unsubscribeEventRequest, unsubscribeEventHeaders, &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 contains the code and message attributes to 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 dingtalkstorage_1_0, * as $dingtalkstorage_1_0 from '@alicloud/dingtalk/storage_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 a Token
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkstorage_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkstorage_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let unsubscribeEventHeaders = new $dingtalkstorage_1_0.UnsubscribeEventHeaders({ });
    unsubscribeEventHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let unsubscribeEventRequest = new $dingtalkstorage_1_0.UnsubscribeEventRequest({
      unionId: "chyxxxxx",
      scopeId: "SPACE",
      scope: "SPACE",
    });
    try {
      await client.unsubscribeEventWithOptions(unsubscribeEventRequest, unsubscribeEventHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // The err contains the code and message attributes to 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 using a Token
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkstorage_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkstorage_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.UnsubscribeEventHeaders unsubscribeEventHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.UnsubscribeEventHeaders();
            unsubscribeEventHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.UnsubscribeEventRequest unsubscribeEventRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.UnsubscribeEventRequest
            {
                UnionId = "chyxxxxx",
                ScopeId = "SPACE",
                Scope = "SPACE",
            };
            try
            {
                client.UnsubscribeEventWithOptions(unsubscribeEventRequest, unsubscribeEventHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err contains the code and message attributes to 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 contains the code and message attributes to help locate the issue
                }
            }
        }

    }
}
```

## Response

### Response body

| Name    | Type    | Description                                              |
| ------- | ------- | -------------------------------------------------------- |
| success | Boolean | Whether the operation 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

{
  "success" : true
}
```

### Error codes

If an error is returned when calling this API, refer to the [Global error codes](/open/development/server-api-error-codes-1) document to find a solution based on the error message.

| HttpCode | Error code         | Error message | Description                                      |
| -------- | ------------------ | ------------- | ------------------------------------------------ |
| 400      | paramError         | %s            | Parameter error                                  |
| 400      | paramError.scope   | %s            | Parameter error - scope                          |
| 400      | paramError.scopeId | %s            | Parameter error - scopeId                        |
| 403      | permissionDenied   | %s            | The user lacks permission to subscribe to events |
| 500      | systemError        | %s            | System error                                     |
| 500      | unknownError       | Unknown Error | Unknown error                                    |
| 503      | operationTimeout   | %s            | Request timed out                                |