Create a new domain

post/senders/domains

Request

Base URL
https://api.brevo.com/v3
Auth
- API key in header api-key
- or API key in header partner-key
TypeScript
https://skmtc.dev/getbrevo/apis/brevo-api/docs/senders/domains/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

Domain name

Example request

{
  "name": "mycompany.com"
}

Response

domain created

idinteger required

ID of the Domain created

domain_namestring

Domain

domain_providerstring

Domain Provider

messagestring

Success message

Example response

{
  "domain_name": "example.com",
  "domain_provider": "GoDaddy",
  "dns_records": {
    "dkim_record": {
      "type": "type",
      "value": "value",
      "host_name": "host_name",
      "status": true
    },
    "dmarc_record": {
      "type": "type",
      "value": "value",
      "host_name": "host_name",
      "status": true
    },
    "brevo_code": {
      "type": "type",
      "value": "value",
      "host_name": "host_name",
      "status": true
    }
  },
  "id": 5,
  "message": "Domain added successfully. To authenticate it, add following DNS records"
}

Changes

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