POST v1/bunits/{bunitId}/DeleteRequestSettings?allowLessRestrictive={allowLessRestrictive}

Add deletion request settings to a business unit.

Request Information

URI Parameters

Name	Description	Type	Additional information
`bunitId`		integer	Required
`allowLessRestrictive`	Whether the user should be allowed to enter less restrictive settings. Only applicable if the user has the privilege to do so	boolean	Default value is False

Body Parameters

DeleteRequestSettings

Name	Description	Type	Additional information
`Type`	What type of deletion requests these settings are applied to	integer	None.
`OffsetDays`	Number of days before a deletion request for a consumption unit can be excecuted	integer	None.
`OffsetMonths`	Number of months before a deletion request for a consumption unit can be excecuted	integer	None.
`EndOfMonth`	If true the first month offset will return end of month	boolean	None.
`MonthSpan`	How many months in to the future it is possible to request deletions	integer	None.
`DeletionDays`	The days during a month deletions can be requested	Collection of integer	None.
`OnlyAllowDeletionDays`	If set to true only days can be selected If set to false the first day after retention will be first selectable day	boolean	None.
`OnlyAllowFirstDay`	If set to true only the first day after retention can be selected	boolean	None.
`GigaBytesWarningLimit`	A limit for when a warning is sent when deletion request is created	decimal number	None.
`MegaBytesWarningLimit`	A limit for when a warning is sent when deletion request is created. Not to be used through API	decimal number	None.
`WarningLimitEmails`	The address any violations of the megabytes limit should be sent to	Collection of string	None.
`Inherited`	Whether or not the settings are related to the current business unit or inherited from a parent	boolean	None.
`Id`	A unique ID for the object.	integer	Read-only.
`CreatedDate`	Time and date the object was created.	date	Read-only.
`ArchivedDate`	Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate	date	Read-only.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<DeleteRequestSettings xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>11</Id>
  <CreatedDate>2024-05-20T17:42:44.8902201+02:00</CreatedDate>
  <ArchivedDate>2024-05-20T17:42:44.8902201+02:00</ArchivedDate>
  <Type>1</Type>
  <OffsetDays>2</OffsetDays>
  <OffsetMonths>3</OffsetMonths>
  <EndOfMonth>true</EndOfMonth>
  <MonthSpan>5</MonthSpan>
  <DeletionDays>
    <int>1</int>
    <int>2</int>
  </DeletionDays>
  <OnlyAllowDeletionDays>true</OnlyAllowDeletionDays>
  <OnlyAllowFirstDay>true</OnlyAllowFirstDay>
  <GigaBytesWarningLimit>8</GigaBytesWarningLimit>
  <MegaBytesWarningLimit>9</MegaBytesWarningLimit>
  <WarningLimitEmails>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </WarningLimitEmails>
  <Inherited>true</Inherited>
</DeleteRequestSettings>

Response Information

Resource Description

DeleteRequestSettings

Name	Description	Type	Additional information
`Type`	What type of deletion requests these settings are applied to	integer	None.
`OffsetDays`	Number of days before a deletion request for a consumption unit can be excecuted	integer	None.
`OffsetMonths`	Number of months before a deletion request for a consumption unit can be excecuted	integer	None.
`EndOfMonth`	If true the first month offset will return end of month	boolean	None.
`MonthSpan`	How many months in to the future it is possible to request deletions	integer	None.
`DeletionDays`	The days during a month deletions can be requested	Collection of integer	None.
`OnlyAllowDeletionDays`	If set to true only days can be selected If set to false the first day after retention will be first selectable day	boolean	None.
`OnlyAllowFirstDay`	If set to true only the first day after retention can be selected	boolean	None.
`GigaBytesWarningLimit`	A limit for when a warning is sent when deletion request is created	decimal number	None.
`MegaBytesWarningLimit`	A limit for when a warning is sent when deletion request is created. Not to be used through API	decimal number	None.
`WarningLimitEmails`	The address any violations of the megabytes limit should be sent to	Collection of string	None.
`Inherited`	Whether or not the settings are related to the current business unit or inherited from a parent	boolean	None.
`Id`	A unique ID for the object.	integer	Read-only.
`CreatedDate`	Time and date the object was created.	date	Read-only.
`ArchivedDate`	Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate	date	Read-only.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<DeleteRequestSettings xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>11</Id>
  <CreatedDate>2024-05-20T17:42:44.8902201+02:00</CreatedDate>
  <ArchivedDate>2024-05-20T17:42:44.8902201+02:00</ArchivedDate>
  <Type>1</Type>
  <OffsetDays>2</OffsetDays>
  <OffsetMonths>3</OffsetMonths>
  <EndOfMonth>true</EndOfMonth>
  <MonthSpan>5</MonthSpan>
  <DeletionDays>
    <int>1</int>
    <int>2</int>
  </DeletionDays>
  <OnlyAllowDeletionDays>true</OnlyAllowDeletionDays>
  <OnlyAllowFirstDay>true</OnlyAllowFirstDay>
  <GigaBytesWarningLimit>8</GigaBytesWarningLimit>
  <MegaBytesWarningLimit>9</MegaBytesWarningLimit>
  <WarningLimitEmails>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </WarningLimitEmails>
  <Inherited>true</Inherited>
</DeleteRequestSettings>