API

Obter um domínio

Acrescenta os endereços que existem nele e se cada um está ativado.

GETapi.openemail.uk/domains/{id}

Executa a chamada real contra o seu espaço de trabalho, com a sua própria chave.

GET /domains/{id}

Acrescenta os endereços que existem nele e se cada um está ativado.

Exemplo

Requer domains:read.

curl

curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f" -H "$AUTH"

Resposta

{  "object": "domain",  "id": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f",  "domain": "acme.com",  "receiving": {    "verified": true,    "verifiedAt": "2026-08-14T10:02:00.000Z",    "catchAll": false,    "lastCheckedAt": "2026-08-29T06:00:00.000Z",    "error": null  },  "sending": {    "status": "verified",    "canSend": true,    "checkedAt": "2026-08-29T06:00:00.000Z",    "error": null,    "note": "Mail from this domain is signed and can be sent."  },  "tracking": {    "host": "links.acme.com",    "status": "active",    "active": true,    "target": "oelinks3f9a1c7e2b8d4a60.edge.openemail.uk",    "record": { "type": "CNAME", "name": "links.acme.com", "value": "oelinks3f9a1c7e2b8d4a60.edge.openemail.uk" },    "checkedAt": "2026-08-29T06:10:00.000Z",    "verifiedAt": "2026-08-29T06:10:00.000Z",    "error": null  },  "storage": {    "host": "files.acme.com",    "status": "active",    "active": true,    "target": "oefiles81c40d6b2f7e9a35.edge.openemail.uk",    "record": { "type": "CNAME", "name": "files.acme.com", "value": "oefiles81c40d6b2f7e9a35.edge.openemail.uk" },    "checkedAt": "2026-08-29T06:10:00.000Z",    "verifiedAt": "2026-08-29T06:10:00.000Z",    "error": null  },  "addresses": [    { "address": "[email protected]", "enabled": true },    { "address": "[email protected]", "enabled": false }  ],  "createdAt": "2026-08-14T09:55:11.000Z"}

Um endereço desativado deixa de ser entregável. O correio para ele é recusado no momento do SMTP, pelo que o remetente recebe uma devolução em vez de silêncio.

O que ainda não pode fazer aqui

Ainda não disponível

As escritas que este recurso aceita são o domínio de rastreio personalizado e o domínio de ficheiros personalizado, ambas através de PATCH /domains/{id}. O resto da configuração de um domínio é, por agora, só na aplicação.

Adicionar um domínio e ler os registos DNS a publicar. O GET indica que um domínio não está verificado, mas não qual o registo em falta.
Desencadear uma nova verificação de receiving ou sending. Nenhuma tem endpoint, e nenhuma precisa: uma varredura de hora a hora volta a verificar sozinha todos os domínios não verificados, pelo que publicar os registos e deixá-los estar é todo o trabalho. Subscreva domain.verified e domain.sending_changed em vez de sondar GET /domains, e fica a saber no momento em que qualquer um deles mudar. PATCH /domains/{id} verifica apenas o domínio de rastreio e o domínio de ficheiros.
Criar, desativar ou encaminhar um endereço. PARTILHAR um está feito, uma vez que POST /members/{userId}/addresses entrega um endereço existente a alguém ao nível member ou viewer. É trazer o endereço à existência que este recurso não consegue fazer.

Tudo isso existe na aplicação em Definições → Domínios. O que falta é a superfície de API, não a capacidade.