Editing Excluded Items

You can edit a list of items that have been excluded from the retention policy for the specified organization.

Request

PUT https://<hostname>:4443/v6/Organizations/{organizationId}/RetentionExclusion

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter

Type

Description

organizationId

string

Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Getting Organizations.

Request Body

The request body must contain the following properties:

Property

Type

Description

contacts

boolean

Defines whether to exclude the Contacts folder from the retention policy list.

calendar

boolean

Defines whether to exclude the Calendar from the retention policy list.

For example:

Request Body:

{

  "contacts": false,

  "calendar": true

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

None.

Example

The example shows how to update the backup exclusion settings.

Request:

PUT https://abc.tech.local:4443/v6/Organizations/4111916c-3a82-4b0b-8d92-13cc1c797bc7/RetentionExclusion

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

  "contacts": false,

  "calendar": true

}

 

Response:

200 OK