Update a directory setting

• 5/31/2019
• 2 minutes to read
• Contributors
  • 
  • 
  • 
  • 
  • 
  • all

Update the properties of a specific directory setting object.

Note: The /beta version of this API is only applies to groups. The /v1.0 version of this API has been renamed to Update groupSettings.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

HTTP request

Update a tenant-wide or group specific setting.

PATCH /settings/{id}
PATCH /groups/{id}/settings/{id}

Optional request headers

Request body

In the request body, supply the values for relevant fields that should be updated.

Response

If successful, this method returns a 204 OK response code.

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/beta/settings/{id}
Content-type: application/json
Content-length: 178

{
  "values": [
    {
      "name": "name-value",
      "value": "value-value"
    }
  ]
}

Response

HTTP/1.1 204 OK

SDK sample code

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var directorySetting = new DirectorySetting
{
	Values = new List<SettingValue>()
	{
		new SettingValue
		{
			Name = "name-value",
			Value = "value-value"
		}
	}
};

await graphClient.Settings["{id}"]
	.Request()
	.UpdateAsync(directorySetting);

const options = {
	authProvider,
};

const client = Client.init(options);

const directorySetting = {
  values: [
    {
      name: "name-value",
      value: "value-value"
    }
  ]
};

let res = await client.api('/settings/{id}')
	.version('beta')
	.update({directorySetting : directorySetting});

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.