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

# Create or update contact hiding settings

> Call this API to create or update contact hiding settings via a PUT request, submitting fields such as name, description, objectStaffIds, objectDeptIds, objectTagIds, and excludeStaffIds.

Use this API to create or update contact hiding settings. Submit the business fields `name`, `description`, `objectStaffIds`, `objectDeptIds`, `objectTagIds`, and `excludeStaffIds` through a PUT request.

## API call description

In the DingTalk OA admin console, you can hide departments. This API extends the hiding capability beyond departments — **you can also hide employees and roles**.

<Note>
  The hiding settings configured through this API are stored independently from those configured in the OA admin console. The final effect is the union (OR) of the two. For example, if the same department is hidden either through this API or through the OA admin console, it is hidden.
</Note>

## Request

### Basic information

| Field                | Value                                                                                                                |
| -------------------- | -------------------------------------------------------------------------------------------------------------------- |
| HTTP URL             | [https://api.dingtalk.io/v1.0/contact/contactHideSettings](https://api.dingtalk.io/v1.0/contact/contactHideSettings) |
| HTTP Method          | PUT                                                                                                                  |
| Supported app types  | appType-Internal app                                                                                                 |
| Required permissions | permission-Contact.Visibility.ReadWrite-Permission to manage the visibility range of contact data                    |

### Request header

| Name                        | Type   | Required | Description                                                                                                                                                                         |
| --------------------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | Yes      | The access credential used to call this API. Obtain it by calling the [Get the access token of an internal app](/open/development/obtain-the-access-token-of-an-internal-app#) API. |

### Request body

| Name              | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                           |
| ----------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name              | String          | No       | The setting name.                                                                                                                                                                                                                                                                                                                                     |
| description       | String          | No       | The description of the setting.                                                                                                                                                                                                                                                                                                                       |
| objectStaffIds    | Array of String | No       | The list of `userId` values of the employees to hide. To obtain the `userId`, call [Get user information by silent login code](/open/development/obtain-the-userid-of-a-user-by-using-the-log-free#).      The total number of elements across `objectStaffIds`, `objectDeptIds`, and `objectTagIds` cannot exceed 50.                                |
| objectDeptIds     | Array of Long   | No       | The list of department IDs to hide. To obtain the `dept_id`, call [Get the department list](https://open.dingtalk.com/document/development/obtain-the-department-list-v2#).      The total number of elements across `objectStaffIds`, `objectDeptIds`, and `objectTagIds` cannot exceed 50.                                                          |
| objectTagIds      | Array of Long   | No       | The list of `roleId` values of the roles to hide. To obtain the `id`, call [Get the role list](/open/development/obtains-a-list-of-enterprise-roles#).      The total number of elements across `objectStaffIds`, `objectDeptIds`, and `objectTagIds` cannot exceed 50.                                                                               |
| excludeStaffIds   | Array of String | No       | The list of `userId` values of the employees not affected by this hiding setting. To obtain the `userId`, call [Get user information by silent login code](/open/development/obtain-the-userid-of-a-user-by-using-the-log-free#).      The total number of elements across `excludeStaffIds`, `excludeDeptIds`, and `excludeTagIds` cannot exceed 50. |
| excludeDeptIds    | Array of Long   | No       | The list of department IDs not affected by this hiding setting. To obtain the `dept_id`, call [Get the department list](https://open.dingtalk.com/document/development/obtain-the-department-list-v2#).      The total number of elements across `excludeStaffIds`, `excludeDeptIds`, and `excludeTagIds` cannot exceed 50.                           |
| excludeTagIds     | Array of Long   | No       | The list of role IDs not affected by this hiding setting. To obtain the `id`, call [Get the role list](/open/development/obtains-a-list-of-enterprise-roles#).      The total number of elements across `excludeStaffIds`, `excludeDeptIds`, and `excludeTagIds` cannot exceed 50.                                                                    |
| active            | Boolean         | No       | Whether the setting is active. Valid values:   - true: active - false: inactive                                                                                                                                                                                                                                                                       |
| id                | Long            | No       | The setting ID.     - Leave it empty when creating a new setting. - Set it to the ID of the setting to update when modifying a setting.                                                                                                                                                                                                               |
| hideInUserProfile | Boolean         | No       | Whether to also hide the user when their profile is viewed. Valid values:   - true: yes - false: no                                                                                                                                                                                                                                                   |
| hideInSearch      | Boolean         | No       | Whether to also hide the user from search results. Valid values:   - true: yes - false: no                                                                                                                                                                                                                                                            |

### Request example

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
PUT /v1.0/contact/contactHideSettings HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:c2c5bxxx
Content-Type:application/json

{
  "name" : "Sample name",
  "description" : "This is a description",
  "objectStaffIds" : [ "userId" ],
  "objectDeptIds" : [ 12345 ],
  "objectTagIds" : [ 112233 ],
  "excludeStaffIds" : [ "54321-1122" ],
  "excludeDeptIds" : [ 123987 ],
  "excludeTagIds" : [ 223344 ],
  "active" : true,
  "id" : 11234,
  "hideInUserProfile" : true,
  "hideInSearch" : true
}
```

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.dingtalkcontact_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.dingtalkcontact_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkcontact_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkcontact_1_0.models.UpdateContactHideSettingHeaders updateContactHideSettingHeaders = new com.aliyun.dingtalkcontact_1_0.models.UpdateContactHideSettingHeaders();
        updateContactHideSettingHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkcontact_1_0.models.UpdateContactHideSettingRequest updateContactHideSettingRequest = new com.aliyun.dingtalkcontact_1_0.models.UpdateContactHideSettingRequest()
                .setName("Sample name")
                .setDescription("This is a description")
                .setObjectStaffIds(java.util.Arrays.asList(
                    "userId"
                ))
                .setObjectDeptIds(java.util.Arrays.asList(
                    12345L
                ))
                .setObjectTagIds(java.util.Arrays.asList(
                    112233L
                ))
                .setExcludeStaffIds(java.util.Arrays.asList(
                    "54321-1122"
                ))
                .setExcludeDeptIds(java.util.Arrays.asList(
                    123987L
                ))
                .setExcludeTagIds(java.util.Arrays.asList(
                    223344L
                ))
                .setActive(true)
                .setId(11234L)
                .setHideInUserProfile(true)
                .setHideInSearch(true);
        try {
            client.updateContactHideSettingWithOptions(updateContactHideSettingRequest, updateContactHideSettingHeaders, 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 object contains the code and message properties 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 object contains the code and message properties 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.contact_1_0.client import Client as dingtalkcontact_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.contact_1_0 import models as dingtalkcontact__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() -> dingtalkcontact_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 dingtalkcontact_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_contact_hide_setting_headers = dingtalkcontact__1__0_models.UpdateContactHideSettingHeaders()
        update_contact_hide_setting_headers.x_acs_dingtalk_access_token = '<your access token>'
        update_contact_hide_setting_request = dingtalkcontact__1__0_models.UpdateContactHideSettingRequest(
            name='Sample name',
            description='This is a description',
            object_staff_ids=[
                'userId'
            ],
            object_dept_ids=[
                12345
            ],
            object_tag_ids=[
                112233
            ],
            exclude_staff_ids=[
                '54321-1122'
            ],
            exclude_dept_ids=[
                123987
            ],
            exclude_tag_ids=[
                223344
            ],
            active=True,
            id=11234,
            hide_in_user_profile=True,
            hide_in_search=True
        )
        try:
            client.update_contact_hide_setting_with_options(update_contact_hide_setting_request, update_contact_hide_setting_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains the code and message properties to help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_contact_hide_setting_headers = dingtalkcontact__1__0_models.UpdateContactHideSettingHeaders()
        update_contact_hide_setting_headers.x_acs_dingtalk_access_token = '<your access token>'
        update_contact_hide_setting_request = dingtalkcontact__1__0_models.UpdateContactHideSettingRequest(
            name='Sample name',
            description='This is a description',
            object_staff_ids=[
                'userId'
            ],
            object_dept_ids=[
                12345
            ],
            object_tag_ids=[
                112233
            ],
            exclude_staff_ids=[
                '54321-1122'
            ],
            exclude_dept_ids=[
                123987
            ],
            exclude_tag_ids=[
                223344
            ],
            active=True,
            id=11234,
            hide_in_user_profile=True,
            hide_in_search=True
        )
        try:
            await client.update_contact_hide_setting_with_options_async(update_contact_hide_setting_request, update_contact_hide_setting_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains the code and message properties 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\Vcontact_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\UpdateContactHideSettingHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\UpdateContactHideSettingRequest;
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();
        $updateContactHideSettingHeaders = new UpdateContactHideSettingHeaders([]);
        $updateContactHideSettingHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $updateContactHideSettingRequest = new UpdateContactHideSettingRequest([
            "name" => "Sample name",
            "description" => "This is a description",
            "objectStaffIds" => [
                "userId"
            ],
            "objectDeptIds" => [
                12345
            ],
            "objectTagIds" => [
                112233
            ],
            "excludeStaffIds" => [
                "54321-1122"
            ],
            "excludeDeptIds" => [
                123987
            ],
            "excludeTagIds" => [
                223344
            ],
            "active" => true,
            "id" => 11234,
            "hideInUserProfile" => true,
            "hideInSearch" => true
        ]);
        try {
            $client->updateContactHideSettingWithOptions($updateContactHideSettingRequest, $updateContactHideSettingHeaders, 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 object contains the code and message properties 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"
  dingtalkcontact_1_0  "github.com/alibabacloud-go/dingtalk/contact_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 *dingtalkcontact_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkcontact_1_0.Client{}
  _result, _err = dingtalkcontact_1_0.NewClient(config)
  return _result, _err
}

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

  updateContactHideSettingHeaders := &dingtalkcontact_1_0.UpdateContactHideSettingHeaders{}
  updateContactHideSettingHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  updateContactHideSettingRequest := &dingtalkcontact_1_0.UpdateContactHideSettingRequest{
    Name: tea.String("Sample name"),
    Description: tea.String("This is a description"),
    ObjectStaffIds: []*string{tea.String("userId")},
    ObjectDeptIds: []*int64{tea.Int64(12345)},
    ObjectTagIds: []*int64{tea.Int64(112233)},
    ExcludeStaffIds: []*string{tea.String("54321-1122")},
    ExcludeDeptIds: []*int64{tea.Int64(123987)},
    ExcludeTagIds: []*int64{tea.Int64(223344)},
    Active: tea.Bool(true),
    Id: tea.Int64(11234),
    HideInUserProfile: tea.Bool(true),
    HideInSearch: tea.Bool(true),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateContactHideSettingWithOptions(updateContactHideSettingRequest, updateContactHideSettingHeaders, &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 object contains the Code and Message properties 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 dingtalkcontact_1_0, * as $dingtalkcontact_1_0 from '@alicloud/dingtalk/contact_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(): dingtalkcontact_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkcontact_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let updateContactHideSettingHeaders = new $dingtalkcontact_1_0.UpdateContactHideSettingHeaders({ });
    updateContactHideSettingHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let updateContactHideSettingRequest = new $dingtalkcontact_1_0.UpdateContactHideSettingRequest({
      name: "Sample name",
      description: "This is a description",
      objectStaffIds: [
        "userId"
      ],
      objectDeptIds: [
        12345
      ],
      objectTagIds: [
        112233
      ],
      excludeStaffIds: [
        "54321-1122"
      ],
      excludeDeptIds: [
        123987
      ],
      excludeTagIds: [
        223344
      ],
      active: true,
      id: 11234,
      hideInUserProfile: true,
      hideInSearch: true,
    });
    try {
      await client.updateContactHideSettingWithOptions(updateContactHideSettingRequest, updateContactHideSettingHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // The err object contains the code and message properties 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.Dingtalkcontact_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkcontact_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateContactHideSettingHeaders updateContactHideSettingHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateContactHideSettingHeaders();
            updateContactHideSettingHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateContactHideSettingRequest updateContactHideSettingRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateContactHideSettingRequest
            {
                Name = "Sample name",
                Description = "This is a description",
                ObjectStaffIds = new List<string>
                {
                    "userId"
                },
                ObjectDeptIds = new List<long?>
                {
                    12345
                },
                ObjectTagIds = new List<long?>
                {
                    112233
                },
                ExcludeStaffIds = new List<string>
                {
                    "54321-1122"
                },
                ExcludeDeptIds = new List<long?>
                {
                    123987
                },
                ExcludeTagIds = new List<long?>
                {
                    223344
                },
                Active = true,
                Id = 11234,
                HideInUserProfile = true,
                HideInSearch = true,
            };
            try
            {
                client.UpdateContactHideSettingWithOptions(updateContactHideSettingRequest, updateContactHideSettingHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err object contains the code and message properties 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 object contains the code and message properties to help locate the issue
                }
            }
        }

    }
}
```

## Response

### Response body

| Name   | Type | Description     |
| ------ | ---- | --------------- |
| result | Long | The setting ID. |

### Response body example

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "result" : 1234001
}
```

### Error codes

If an error is returned when you call this API, see the [Global error codes](/open/development/server-api-error-codes-1) document for the solution.

| HttpCode | Error code      | Error message                | Description                  |
| -------- | --------------- | ---------------------------- | ---------------------------- |
| 400      | parameter.error | Parameter error              | Parameter error              |
| 500      | system.error    | Failed to update the setting | Failed to update the setting |