Consultar envio e-mail
curl --request GET \
--url https://api.notifique.dev/v1/email/messages/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.notifique.dev/v1/email/messages/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.notifique.dev/v1/email/messages/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.notifique.dev/v1/email/messages/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"data": {
"id": "clxx123...",
"to": "cliente@example.com",
"from": "Suporte <noreply@seudominio.com>",
"subject": "Confirmação",
"status": "SENT",
"scheduledFor": null,
"sentAt": "2025-02-16T12:00:00.000Z",
"deliveredAt": null,
"failedAt": null,
"errorMessage": null,
"createdAt": "2025-02-16T11:59:58.000Z",
"toRecipients": [
"cliente@example.com"
],
"cc": [],
"bcc": [],
"replyTo": [],
"sendMode": "FANOUT",
"messageId": null,
"attachments": []
}
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Not Found",
"message": "Email not found",
"code": "NOT_FOUND"
}E-mail
Consultar envio e-mail
Consulta se foi enviado, entregue ou falhou, e vê os detalhes.
GET
/
v1
/
email
/
messages
/
{id}
Consultar envio e-mail
curl --request GET \
--url https://api.notifique.dev/v1/email/messages/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.notifique.dev/v1/email/messages/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.notifique.dev/v1/email/messages/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.notifique.dev/v1/email/messages/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"data": {
"id": "clxx123...",
"to": "cliente@example.com",
"from": "Suporte <noreply@seudominio.com>",
"subject": "Confirmação",
"status": "SENT",
"scheduledFor": null,
"sentAt": "2025-02-16T12:00:00.000Z",
"deliveredAt": null,
"failedAt": null,
"errorMessage": null,
"createdAt": "2025-02-16T11:59:58.000Z",
"toRecipients": [
"cliente@example.com"
],
"cc": [],
"bcc": [],
"replyTo": [],
"sendMode": "FANOUT",
"messageId": null,
"attachments": []
}
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Not Found",
"message": "Email not found",
"code": "NOT_FOUND"
}Autorizações
ntfEmailBearerAuthntfEmailApiKeyHeader
API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx
Parâmetros de caminho
ID (cuid) do e-mail retornado em POST /v1/email/messages.
Resposta
Dados do e-mail.
Exemplo:
true
Metadados de envio retornados na listagem e em GET por ID; a API sempre devolve todos estes campos (nullable onde indicado).
Show child attributes
Show child attributes
Exemplo:
{
"id": "clxx...",
"to": "5511999999999",
"from": "5511999999999",
"subject": "string",
"status": "QUEUED",
"scheduledFor": "2025-02-10T14:00:00.000Z",
"sentAt": "2025-02-10T14:00:00.000Z",
"deliveredAt": "2025-02-10T14:00:00.000Z",
"failedAt": "2025-02-10T14:00:00.000Z",
"errorMessage": "string",
"createdAt": "2025-02-10T14:00:00.000Z",
"toRecipients": ["string"],
"cc": ["string"],
"bcc": ["string"],
"replyTo": ["string"],
"sendMode": "FANOUT",
"attachments": [
{
"filename": "string",
"contentType": "string",
"sizeBytes": 1
}
]
}
Esta página foi útil?

