PUT v1/surveys/{surveyId}/DataRetentionSettings

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser LimitedUser OperationsUser

Permissions required to make this request: Survey.Write Survey.Read

Has survey type usage restrictions online

Update the data retention settings for a survey

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The id of the survey	string	Required

Body Parameters

Object containing the data retention settings

UpdateDataRetentionSettingsModel

Name	Description	Type	Additional information
RetentionPeriod	The survey data retention period in days	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "RetentionPeriod": 1
}

application/xml, text/xml

Sample:

<UpdateDataRetentionSettingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <RetentionPeriod>1</RetentionPeriod>
</UpdateDataRetentionSettingsModel>

application/x-www-form-urlencoded

Sample:

RetentionPeriod=1

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Response Message

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.