Listar domínios

gethttps://app.madmail.com.br/api/v1/domains

Requer autenticação: Authorization: Bearer us_SUA_CHAVE

Exemplo de requisição

curl -X GET "https://app.madmail.com.br/api/v1/domains" \
  -H "Authorization: Bearer us_SUA_CHAVE"

Resposta

200

Recupera os domínios acessíveis pela chave de API

Lista de objetos com os campos:

idnumberObrigatório

ID do domínio

namestringObrigatório

Nome do domínio

teamIdnumberObrigatório

ID do workspace

statusstringObrigatório
Valores:
"NOT_STARTED" · "PENDING" · "SUCCESS" · "FAILED" · "TEMPORARY_FAILURE"
regionstringOpcional
Padrão:
"us-east-1"
clickTrackingbooleanOpcional
Padrão:
false
openTrackingbooleanOpcional
Padrão:
false
publicKeystringObrigatório
dkimStatusstring | nullOpcional
spfDetailsstring | nullOpcional
createdAtstringObrigatório
updatedAtstringObrigatório
dmarcAddedbooleanOpcional
Padrão:
false
isVerifyingbooleanOpcional
Padrão:
false
errorMessagestring | nullOpcional
subdomainstring | nullOpcional
verificationErrorstring | nullOpcional
lastCheckedTimestring | nullOpcional
dnsRecordsarray<object>Obrigatório
typestringObrigatório

Tipo do registro DNS

Valores:
"MX" · "TXT"
namestringObrigatório

Nome do registro DNS

valuestringObrigatório

Valor do registro DNS

ttlstringObrigatório

TTL do registro DNS

prioritystring | nullOpcional

Prioridade do registro DNS

statusstringObrigatório
Valores:
"NOT_STARTED" · "PENDING" · "SUCCESS" · "FAILED" · "TEMPORARY_FAILURE"
[
  {
    "id": 1,
    "name": "example.com",
    "teamId": 1,
    "status": "NOT_STARTED",
    "publicKey": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "dnsRecords": [
      {
        "type": "TXT",
        "name": "mail",
        "value": "v=spf1 include:amazonses.com ~all",
        "ttl": "Auto",
        "status": "NOT_STARTED"
      }
    ]
  }
]