Domain creation and management

Domains are used for authenticating and verifying the senders so that a user knows that the email is being sent from a genuine source. You can check out the endpoints for creating and managing domains at API reference > Domains.

1. Creating a new domain

You can use the endpoint https://api.brevo.com/v3/senders/domainswith the POST method to send a request to the API for creating a new domain. You can use the cURL request below for this endpoint.

1
curl --request POST \
2
     --url https://api.brevo.com/v3/senders/domains \
3
     --header 'accept: application/json' \
4
     --header 'api-key:' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
  "name": "mycompany.com"
9
}
10
'

You can add your API key in the header api-key above in the cURL request. This endpoint only has one body parameter which is defined in the table below.

Response

You will receive a success response something like this below:

1
{
2
  "id": "641db448a6a7ea326e585e15",
3
  "domain_name": "mycompany.com",
4
  "message": "Domain added successfully. To authenticate it, add following DNS records",
5
  "dns_records": {
6
    "dkim_record": {
7
      "type": "TXT",
8
      "value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDeMVIzrCa3T14JsNY0IRv5/2V1/v2itlviLQBwXsa7shBD6TrBkswsFUToPyMRWC9tbR/5ey0nRBH0ZVxp+lsmTxid2Y2z+FApQ6ra2VsXfbJP3HE6wAO0YTVEJt1TmeczhEd2Jiz/fcabIISgXEdSpTYJhb0ct0VJRxcg4c8c7wIDAQAB",
9
      "host_name": "mail._domainkey.",
10
      "status": false
11
    },
12
    "brevo_code": {
13
      "type": "TXT",
14
      "value": "brevo-code:4bc1566441c4131069853d135c5905ab",
15
      "host_name": "",
16
      "status": false
17
    }
18
  }
19
}

On the other hand, A bad request response would be something like this:

1
{
2
  "code": "invalid_parameter",
3
  "message": "Enter domain name in correct format. Example: myexampledomain.com"
4
}

You can view the responses for the request you send below in the table:

2. Getting the list of your domains

You can use this endpoint to retrieve created domains. You can use the endpoint https://api.brevo.com/v3/senders/domains using the GET method. You can use the cURL request below

1
curl --request GET \
2
     --url https://api.brevo.com/v3/senders/domains \
3
     --header 'accept: application/json' \
4
     --header 'api-key: '

Response

A sample response would return all the domains you have created just like in the below JSON format.

1
{
2
  "domains": [
3
    {
4
      "id": "641db6b43f10ae7b6604d178",
5
      "domain_name": "mycompany.com",
6
      "authenticated": false,
7
      "verified": false,
8
      "validationRequest": null,
9
      "verifier": null,
10
      "authenticator": null,
11
      "creator": {
12
        "id": "63930fe975f3bf52825956b7",
13
        "email": "obaidullah.khan@brevo.com",
14
        "method": null,
15
        "creationDate": "2023-03-24T14:41:56+00:00"
16
      },
17
      "ip": null
18
    }
19
  ],
20
  "count": 1,
21
  "current_page": 1,
22
  "total_pages": 1
23
}

Response codes for the endpoint are mentioned below in a table.

3. Delete a domain

You can delete a domain by using the endpoint https://api.brevo.com/v3/senders/domains/{domainName} with the DELETE method. You can put the domain name in endpoint URL in the cURL request as shown below.

1
curl --request DELETE \
2
     --url https://api.brevo.com/v3/senders/domains/mydomain.com \
3
     --header 'accept: application/json' \
4
     --header 'api-key: '

A sample and appropriate response would return null which shows that domain has been deleted. This endpoint only uses domainName as an attribute which is mentioned in the table below.

Response