ELelasticemail
Domains

Update Domain

Updates the specified domain. Required Access Level: ModifySettings

put/domains/{domain}

Request

  • Base URL
    https://api.elasticemail.com/v4
  • URL
    https://api.elasticemail.com/v4/domains/{domain}
  • Auth
    API key in header X-ElasticEmail-ApiKey

Path parameters

domainstring string required

string

Name of the given domain

Request body

CertificateStatus'ErrorOccured' | 'CertNotSet' | 'Valid' | 'NotValid'
VERPboolean
CustomBouncesDomainstring string
IsCustomBouncesDomainDefaultboolean

Response

OK

Domainstring string

Name of selected domain.

DefaultDomainboolean

True, if domain is used as default. Otherwise, false,

Spfboolean

True, if SPF record is verified

Dkimboolean

True, if DKIM record is verified

MXboolean

True, if MX record is verified

DMARCboolean
IsRewriteDomainValidboolean

True, if tracking CNAME record is verified

Verifyboolean

True, if DKIM, SPF, or tracking are still to be verified

Type'None' | 'Delete' | 'Http' | 'ExternalHttps' | 'InternalCertHttps' | 'LetsEncryptCert'

HTTP or HTTPS Protocal used for link tracking.

TrackingStatus'Validated' | 'NotValidated' | 'Invalid' | 'Broken'

Status of ValidDomain to determine how often tracking validation should be performed.

CertificateStatus'ErrorOccured' | 'CertNotSet' | 'Valid' | 'NotValid'
CertificateValidationErrorstring string
TrackingTypeUserRequest'None' | 'Delete' | 'Http' | 'ExternalHttps' | 'InternalCertHttps' | 'LetsEncryptCert'

HTTP or HTTPS Protocal used for link tracking.

VERPboolean
CustomBouncesDomainstring string
IsCustomBouncesDomainDefaultboolean
IsMarkedForDeletionboolean
Ownership'Current' | 'Parent'

Example response

{
  "Domain": "example.com"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.