GET v1/Surveys/{surveyId}/EmailSettings

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

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

Has survey type usage restrictions online

Supports survey simulations

Get email settings for the survey.

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

email settings of the survey

Response Message

SurveyEmailSettingsResponse

Name	Description	Type	Additional information
DomainEmailSettings	The email settings of the domain to which the survey belongs	DomainEmailSettingsModel	None.
SurveyEmailSettings	The actual email settings for this survey	SurveyEmailSettingsModel	None.

Response Formats

application/json, text/json

Sample:

{
  "DomainEmailSettings": {
    "DefaultFromAddress": "sample string 1",
    "DefaultReplyToAddress": "sample string 2",
    "FromAddress": "sample string 3",
    "FromName": "sample string 4",
    "ReplyToAddress": "sample string 5",
    "PostalAddress": "sample string 6"
  },
  "SurveyEmailSettings": {
    "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:

<SurveyEmailSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <DomainEmailSettings>
    <FromAddress>sample string 3</FromAddress>
    <FromName>sample string 4</FromName>
    <PostalAddress>sample string 6</PostalAddress>
    <ReplyToAddress>sample string 5</ReplyToAddress>
    <DefaultFromAddress i:nil="true" />
    <DefaultReplyToAddress i:nil="true" />
    <DefaultFromAddress>sample string 1</DefaultFromAddress>
    <DefaultReplyToAddress>sample string 2</DefaultReplyToAddress>
  </DomainEmailSettings>
  <SurveyEmailSettings>
    <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>
  </SurveyEmailSettings>
</SurveyEmailSettingsResponse>