PUT v1/Surveys/{surveyId}/EmailSettings

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

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

Has survey type usage restrictions online

Update email settings for the survey.

Request Information

URI Parameters

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

Body Parameters

new email settings

InvitationSurveyEmailSettings

Name	Description	Type	Additional information
Id	Survey ID	string	Max length: 36
FromAddress	Email address of the sender	string	Max length: 512
FromName	Senders name	string	Max length: 512
ReplyToAddress	Reply to email address	string	Max length: 512
PostalAddress	Senders postal address	string	Max length: 512
EmailColumn	The column used to store the emails	string	Max length: 512

Request Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "FromAddress": "sample string 2",
  "FromName": "sample string 3",
  "ReplyToAddress": "sample string 4",
  "PostalAddress": "sample string 5",
  "EmailColumn": "sample string 6"
}

application/xml, text/xml

Sample:

<InvitationSurveyEmailSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <EmailColumn>sample string 6</EmailColumn>
  <FromAddress>sample string 2</FromAddress>
  <FromName>sample string 3</FromName>
  <Id>sample string 1</Id>
  <PostalAddress>sample string 5</PostalAddress>
  <ReplyToAddress>sample string 4</ReplyToAddress>
</InvitationSurveyEmailSettings>

application/x-www-form-urlencoded

Sample:

Id=sample&FromAddress=sample&FromName=sample&ReplyToAddress=sample&PostalAddress=sample&EmailColumn=sample

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

the updated email settings

Response Message

SurveyEmailSettingsModel

Name	Description	Type	Additional information
Id	The id of the survey	string	None.
EmailColumn	The column used to store the emails	string	Max length: 512
FromAddress	The 'from' email address	string	Max length: 512
FromName	Name of the sender	string	Max length: 512
ReplyToAddress	The 'reply to' address	string	Max length: 512
PostalAddress	The physical address	string	Max length: 512

Response Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "EmailColumn": "sample string 2",
  "FromAddress": "sample string 3",
  "FromName": "sample string 4",
  "ReplyToAddress": "sample string 5",
  "PostalAddress": "sample string 6"
}

application/xml, text/xml

Sample:

<SurveyEmailSettingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <FromAddress>sample string 3</FromAddress>
  <FromName>sample string 4</FromName>
  <PostalAddress>sample string 6</PostalAddress>
  <ReplyToAddress>sample string 5</ReplyToAddress>
  <EmailColumn>sample string 2</EmailColumn>
  <Id>sample string 1</Id>
</SurveyEmailSettingsModel>