POST example/api/SendingDomain

https://app.bwz.se/bedrock/example/api/SendingDomain

Creates a Sending domain.

Request Information

URI Parameters

None.

Body Parameters

The custom return-path domain to be used if UseCustomReturnPath is true

Name	Description	Type	Additional information
Domain	The domain to be used as the domain part in the from email adress	string	Required
DkimSelector	The dkim selector to locate public key	string	None.
CertificateName	The certificate name to use for the	string	None.
IsEnabled	Is this SendingDomain enabled	boolean	None.
UseCustomReturnPath	Is a custom return path used	boolean	None.
CustomReturnPathDomain	The custom return-path domain to be used if UseCustomReturnPath is true	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Domain": "sample string 1",
  "DkimSelector": "sample string 2",
  "CertificateName": "sample string 3",
  "IsEnabled": true,
  "UseCustomReturnPath": true,
  "CustomReturnPathDomain": "sample string 6"
}

application/xml, text/xml

Sample:

<CreateSendingDomainArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SendingDomain">
  <CertificateName>sample string 3</CertificateName>
  <CustomReturnPathDomain>sample string 6</CustomReturnPathDomain>
  <DkimSelector>sample string 2</DkimSelector>
  <Domain>sample string 1</Domain>
  <IsEnabled>true</IsEnabled>
  <UseCustomReturnPath>true</UseCustomReturnPath>
</CreateSendingDomainArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The SendingDomainModel that has been created.

SendingDomainModel

Name	Description	Type	Additional information
Id	The id of the sending domain	integer	None.
Domain	The domain	string	None.
IsDomainVerified	Is ownership of the domain verified via the verification code	boolean	None.
DomainVerificationCode	The code used in the DNS to verify ownership	string	None.
ValidDkim	Does it have a valid dkim	boolean	None.
CertificateName	The certificate to be used as private key (default= dkim.bedrock.lime-technologies.com)	string	None.
DkimSelector	the selector used for dkim - should be "bedrock"	string	None.
IsDefault	Is this the default SendingDomain	boolean	None.
IsEnabled	Is the domain active	boolean	None.
UseCustomReturnPath	Is a custom return path used	boolean	None.
ValidCustomReturnPath	Is the custom return path valid	boolean	None.
CustomReturnPathDomain	The custom return path domain	string	None.
ValidDmarc	Does it have valid DMARC	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Domain": "sample string 2",
  "IsDomainVerified": true,
  "DomainVerificationCode": "sample string 4",
  "ValidDkim": true,
  "CertificateName": "sample string 6",
  "DkimSelector": "sample string 7",
  "IsDefault": true,
  "IsEnabled": true,
  "UseCustomReturnPath": true,
  "ValidCustomReturnPath": true,
  "CustomReturnPathDomain": "sample string 12",
  "ValidDmarc": true
}

application/xml, text/xml

Sample:

<SendingDomainModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SendingDomain">
  <CertificateName>sample string 6</CertificateName>
  <CustomReturnPathDomain>sample string 12</CustomReturnPathDomain>
  <DkimSelector>sample string 7</DkimSelector>
  <Domain>sample string 2</Domain>
  <DomainVerificationCode>sample string 4</DomainVerificationCode>
  <Id>1</Id>
  <IsDefault>true</IsDefault>
  <IsDomainVerified>true</IsDomainVerified>
  <IsEnabled>true</IsEnabled>
  <UseCustomReturnPath>true</UseCustomReturnPath>
  <ValidCustomReturnPath>true</ValidCustomReturnPath>
  <ValidDkim>true</ValidDkim>
  <ValidDmarc>true</ValidDmarc>
</SendingDomainModel>