PUT v1/EmailSettings

User roles allowed to make this request: DomainAdministrator

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

Update the domain's email settings.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
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

Request Formats

application/json, text/json

Sample:

{
  "FromAddress": "sample string 1",
  "FromName": "sample string 2",
  "ReplyToAddress": "sample string 3",
  "PostalAddress": "sample string 4"
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

FromAddress=sample&FromName=sample&ReplyToAddress=sample&PostalAddress=sample

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Response Message

EmailSettingsModel

Name	Description	Type	Additional information
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:

{
  "FromAddress": "sample string 1",
  "FromName": "sample string 2",
  "ReplyToAddress": "sample string 3",
  "PostalAddress": "sample string 4"
}

application/xml, text/xml

Sample:

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