Update copilotAdminLimitedMode

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Update the properties of a copilotAdminLimitedMode object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	CopilotSettings-LimitedMode.ReadWrite	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned the Global Administrator Microsoft Entra role.

HTTP request

PATCH /copilot/admin/settings/limitedMode

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

Property	Type	Description
isEnabledForGroup	Boolean	Enables the user to be in limited mode for Copilot in Teams meetings. When copilotLimitedMode=true, users in this mode can ask any questions, but Copilot doesn't respond to certain questions related to inferring emotions, behavior, or judgments. When copilotLimitedMode=false, the current mode for Copilot, it responds to any types of questions grounded to the meeting conversation. The default value is false.
groupId	String	The ID of a Microsoft Entra group, of which the value of isEnabledForGroup is applied value for its members. The default value is null. This parameter is optional. If isEnabledForGroup is set to true, the groupId value must be provided for the copilotLimitedMode to be enabled for the members of the group.

Response

If successful, this method returns a 200 OK response code and an updated copilotAdminLimitedMode object in the response body.

API can return additional HTTP status codes such as 403 Forbidden, 500 Internal Server Error, or 429 Too Many Requests.

Examples

Request

The following example shows a request.

HTTP

PATCH https://graph.microsoft.com/beta/copilot/admin/settings/limitedMode
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.copilotAdminLimitedMode",
  "isEnabledForGroup": "Boolean",
  "groupId": "String"
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new CopilotAdminLimitedMode
{
	OdataType = "#microsoft.graph.copilotAdminLimitedMode",
	IsEnabledForGroup = boolean,
	GroupId = "String",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Copilot.Admin.Settings.LimitedMode.PatchAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

mgc-beta copilot admin settings limited-mode patch --body '{\
  "@odata.type": "#microsoft.graph.copilotAdminLimitedMode",\
  "isEnabledForGroup": "Boolean",\
  "groupId": "String"\
}\
'

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewCopilotAdminLimitedMode()
isEnabledForGroup := boolean
requestBody.SetIsEnabledForGroup(&isEnabledForGroup) 
groupId := "String"
requestBody.SetGroupId(&groupId) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
limitedMode, err := graphClient.Copilot().Admin().Settings().LimitedMode().Patch(context.Background(), requestBody, nil)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

CopilotAdminLimitedMode copilotAdminLimitedMode = new CopilotAdminLimitedMode();
copilotAdminLimitedMode.setOdataType("#microsoft.graph.copilotAdminLimitedMode");
copilotAdminLimitedMode.setIsEnabledForGroup(boolean);
copilotAdminLimitedMode.setGroupId("String");
CopilotAdminLimitedMode result = graphClient.copilot().admin().settings().limitedMode().patch(copilotAdminLimitedMode);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const copilotAdminLimitedMode = {
  '@odata.type': '#microsoft.graph.copilotAdminLimitedMode',
  isEnabledForGroup: 'Boolean',
  groupId: 'String'
};

await client.api('/copilot/admin/settings/limitedMode')
	.version('beta')
	.update(copilotAdminLimitedMode);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\CopilotAdminLimitedMode;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new CopilotAdminLimitedMode();
$requestBody->setOdataType('#microsoft.graph.copilotAdminLimitedMode');
$requestBody->setIsEnabledForGroup(boolean);
$requestBody->setGroupId('String');

$result = $graphServiceClient->copilot()->admin()->settings()->limitedMode()->patch($requestBody)->wait();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.copilot_admin_limited_mode import CopilotAdminLimitedMode
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CopilotAdminLimitedMode(
	odata_type = "#microsoft.graph.copilotAdminLimitedMode",
	is_enabled_for_group = Boolean,
	group_id = "String",
)

result = await graph_client.copilot.admin.settings.limited_mode.patch(request_body)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json