Introduction

This section of API allows to manage customer email domains.

Domain Email Config model

Example

{
  "domain_email_config": {
    "id": 1,
    "mail_from_domain": "bounce.placewise.com",
    "dns_records": [
      {
        "key": "y3jnjabnbqldbh5d4bfaedjvjpju5i54._domainkey.test.placewise.com",
        "type": "CNAME",
        "value": "y3jnjabnbqldbh5d4bfaedjvjpju5i54.dkim.amazonses.com"
      },
      {
        "key": "cfyzgedunizfxz3enuxshejgvxmr4ifv._domainkey.test.placewise.com",
        "type": "CNAME",
        "value": "cfyzgedunizfxz3enuxshejgvxmr4ifv.dkim.amazonses.com"
      },
      {
        "key": "phuanj7hrl6yed4a5c2di46khatjtkrf._domainkey.test.placewise.com",
        "type": "CNAME",
        "value": "phuanj7hrl6yed4a5c2di46khatjtkrf.dkim.amazonses.com"
      },
      {
        "key": "bounce.placewise.com",
        "type": "MX",
        "value": "10 feedback-smtp.eu-central-1.amazonses.com"
      },
      {
        "key": "bounce.placewise.com",
        "type": "TXT",
        "value": "v=spf1 include:amazonses.com ~all"
      }
    ],
    "status": {
      "identity_verified": false,
      "mail_from_verified": false
    },
    "created_at": "2024-02-21T10:14:16.593398Z",
    "updated_at": "2024-02-21T10:14:16.593398Z"
  }
}

Definition

Key	Type	Optional	Read-only	Description
id	integer	no	yes
mail_from_domain	String	no	yes	Mail from subdomain + domain address
dns_records	Array[Hash]	no	yes	Array of objects with the following fields: ["key", "type", "value"]
dns_records.key	String	no	yes
dns_records.type	String	no	yes
dns_records.value	String	no	yes
status	Hash	no	yes	Object with the following fields: ["identity_verified", "mail_from_verified"]
status.identity_verified	boolean	no	yes
status.mail_from_verified	boolean	no	yes
created_at	datetime	no	yes	Time of record creation
updated_at	datetime	no	yes	Time of record last update

Domain Email Config model#

Example#

Definition#

Domain Email Config model

Example

Definition