Cadastrar domínio de e-mail

curl --request POST \
  --url https://api.notifique.dev/v1/email/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "suaempresa.com"
}
'

{
  "success": true,
  "data": {
    "id": "clxx123...",
    "domain": "seudominio.com",
    "status": "PENDING",
    "dnsRecords": [
      {
        "type": "TXT",
        "name": "notifique._domainkey.seudominio.com",
        "value": "p=MIGf..."
      }
    ],
    "createdAt": "2025-02-15T10:00:00.000Z"
  },
  "message": "Add the DNS record(s) above to your domain, then call the verify endpoint or use the Verify button in the dashboard."
}

{
  "success": false,
  "error": "Bad Request",
  "message": "Invalid domain",
  "details": [
    {
      "field": "domain",
      "message": "domain must be a valid domain name"
    }
  ],
  "code": "BAD_REQUEST"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "data": {}
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "data": {}
}

{
  "success": false,
  "error": "Plan limit reached",
  "message": "Your plan allows up to N domain(s). Upgrade to add more.",
  "code": "PLAN_LIMIT_EMAIL_DOMAINS"
}

{
  "success": false,
  "error": "Conflict",
  "message": "This domain is already registered for this workspace.",
  "data": {
    "id": "clxx...",
    "domain": "seudominio.com",
    "status": "PENDING"
  },
  "code": "CONFLICT"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "data": {}
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "data": {}
}

POST

domains

curl --request POST \
  --url https://api.notifique.dev/v1/email/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "suaempresa.com"
}
'

{
  "success": true,
  "data": {
    "id": "clxx123...",
    "domain": "seudominio.com",
    "status": "PENDING",
    "dnsRecords": [
      {
        "type": "TXT",
        "name": "notifique._domainkey.seudominio.com",
        "value": "p=MIGf..."
      }
    ],
    "createdAt": "2025-02-15T10:00:00.000Z"
  },
  "message": "Add the DNS record(s) above to your domain, then call the verify endpoint or use the Verify button in the dashboard."
}

{
  "success": false,
  "error": "Bad Request",
  "message": "Invalid domain",
  "details": [
    {
      "field": "domain",
      "message": "domain must be a valid domain name"
    }
  ],
  "code": "BAD_REQUEST"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "data": {}
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "data": {}
}

{
  "success": false,
  "error": "Plan limit reached",
  "message": "Your plan allows up to N domain(s). Upgrade to add more.",
  "code": "PLAN_LIMIT_EMAIL_DOMAINS"
}

{
  "success": false,
  "error": "Conflict",
  "message": "This domain is already registered for this workspace.",
  "data": {
    "id": "clxx...",
    "domain": "seudominio.com",
    "status": "PENDING"
  },
  "code": "CONFLICT"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "data": {}
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "data": {}
}

Autorizações

Authorization

string

header

obrigatório

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Corpo

application/json

domain

string

obrigatório

Domínio que você vai usar no remetente (ex.: suaempresa.com ou mail.suaempresa.com).

Minimum string length: 1

Resposta

Domínio registrado. Configure os registros DNS retornados e depois chame o endpoint de verify.

success

boolean

obrigatório

Exemplo:

true

data

object

obrigatório

Show child attributes

message

string

Mensagem orientando a configurar DNS e chamar verify.

Listar domínios de e-mail Consultar domínio de e-mail