Changelog

April 9, 2024

New value domain provider added in Domain Management API

A new value is added in the response of the Create a domain API endpoint. The response will now look as the JSON mentioned below.

Route: Create a domain

When a new domain is added

1"id": "660e6e0bc8be0885324be29a",
2  "domain_name": "mydomain.com",
3  "domain_provider": "GoDaddy",
4  "message": "Domain added successfully. To authenticate it, add following DNS records",
5  "dns_records": {
6    "dkim_record": {
7      "type": "TXT",
8      "value": "{DKIM value}",
9      "host_name": "test-sib._domainkey",
10      "status": false
11    },
12    "brevo_code": {
13      "type": "TXT",
14      "value": "{brevo code value}",
15      "host_name": "@",
16      "status": false
17    },
18    "dmarc_record": {
19      "type": "TXT",
20      "value": "v=DMARC1; p=none; rua=mailto:rua@dmarc.brevo.com",
21      "host_name": "_dmarc",
22      "status": false
23    }
24  }
25}

When a new sub-domain is added

1"id": "660e6e0bc8be0885324be29a",
2  "domain_name": "subdomain.mydomain.com",
3  "domain_provider": "GoDaddy",
4  "message": "Domain added successfully. To authenticate it, add following DNS records",
5  "dns_records": {
6    "dkim_record": {
7      "type": "TXT",
8      "value": "{DKIM value}",
9      "host_name": "test-sib._domainkey.subdomain",
10      "status": false
11    },
12    "brevo_code": {
13      "type": "TXT",
14      "value": "{brevo code value}",
15      "host_name": "subdomain",
16      "status": false
17    },
18    "dmarc_record": {
19      "type": "TXT",
20      "value": "v=DMARC1; p=none; rua=mailto:rua@dmarc.brevo.com",
21      "host_name": "_dmarc.subdomain",
22      "status": false
23    }
24  }
25}

For Validate domain configuration, the response will look like this.

Route: Validate Domain Configuration

When a new domain is added

1{
2  "domain": "mydomain.com",
3  "verified": false,
4  "authenticated": false,
5  "dns_records": {
6    "dkim_record": {
7      "type": "TXT",
8      "value": "{DKIM value}",
9      "host_name": "test-sib._domainkey",
10      "status": false
11    },
12    "brevo_code": {
13      "type": "TXT",
14      "value": "{Brevo code value}",
15      "host_name": "@",
16      "status": false
17    },
18    "dmarc_record": {
19      "type": "TXT",
20      "value": "v=DMARC1; p=none; rua=mailto:rua@dmarc.brevo.com",
21      "host_name": "_dmarc",
22      "status": true
23    }
24  }
25}

When a new sub-domain is added

1{
2  "domain": "subdomain.mydomain.com",
3  "verified": false,
4  "authenticated": false,
5  "dns_records": {
6    "dkim_record": {
7      "type": "TXT",
8      "value": "{DKIM value}",
9      "host_name": "test-sib._domainkey.subdomain",
10      "status": false
11    },
12    "brevo_code": {
13      "type": "TXT",
14      "value": "{Brevo code value}",
15      "host_name": "subdomain",
16      "status": false
17    },
18    "dmarc_record": {
19      "type": "TXT",
20      "value": "v=DMARC1; p=none; rua=mailto:rua@dmarc.brevo.com",
21      "host_name": "_dmarc..subdomain",
22      "status": true
23    }
24  }
25}

The format of DNS records value will change based on whether user is adding a domain or subdomain.