A criação de API key está disponível no link: https://app.emailmassivo.com/api.
Você pode ler informações detalhadas sobre a criação de API key em nossa Base de conhecimento.
Importante: os e-mails de teste devem ser enviados apenas para endereços de e-mail existentes, caso contrário a chave será bloqueada.
POST https://api.emailmassivo.com/api/v1/external-mails/send
No cabeçalho «X-Api-Key» é necessário passar como string a chave API para autenticação.
{
"idempotencyKey": "unique-key-string",
"mail": {
"to": {
"email": "[email protected]",
"name": "string"
},
"from": {
"email": "[email protected]",
"name": "string"
},
"subject": "string",
"previewTitle": "string",
"headers": {
},
"cc": "string",
"bcc": "string",
"html": "string",
"text": "string"
}
}
Importante:
Para receber o e-mail, é obrigatório ter pelo menos um tipo de conteúdo — html ou text. Se ambos os campos estiverem ausentes, o e-mail será rejeitado.
{ "nome_arquivo.extensão": "corpo do arquivo codificado em base64"};
Se dentro de uma hora chegar uma solicitação repetida para enviar um e-mail com parâmetros completamente coincidentes:
Então:
uuid do e-mail que na primeira solicitação, o reenvio não cria um novo e-mail;idempotencyKey, é passada fora do bloco mail) os e-mails são considerados diferentes quando os valores da chave diferem e serão enviados novamente.Recomendamos enfaticamente passar sempre sua idempotencyKey única.
O uso da chave de idempotência do usuário é considerado necessário para um gerenciamento confiável de solicitações repetidas.
O mecanismo de detecção automática de repetições sem chave existe apenas para compatibilidade retroativa e proteção básica contra duplicação, mas não garante a ausência de envios omitidos ou adicionais.
| Status | Descrição |
|---|---|
| 201 | Email accepted for sending Exemplo: { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"} |
| 400 | Bad Request — formato de solicitação incorreto |
| 401 | Unauthorized — chave API incorreta ou ausente |
| 403 | Forbidden — acesso negado |
| 422 | Unprocessable Entity — erro de validação de dados |
| 429 | Too Many Requests — limite de solicitações excedido |
| 500 | Internal Server Error — erro interno do servidor |
POST https://api.emailmassivo.com/api/v1/external-mails/send-by-template
No cabeçalho «X-Api-Key» é necessário passar como string a chave API para autenticação.
{
"idempotencyKey": "unique-key-string",
"mail": {
"to": {
"email": "[email protected]",
"name": "string"
},
"from": {
"email": "[email protected]",
"name": "string"
},
"subject": "string",
"previewTitle": "string",
"idTemplateMailUser": number,
"params": {
"test": "string",
"test1": "string",
"test2": "string"
}
}
}
$url = 'https://api.emailmassivo.com/api/v1/external-mails/send-by-template';
$data = array(
'idempotencyKey' => 'unique-key-string',
'mail' => array(
'to' => array(
'email' => '[email protected]',
'name' => 'string'
),
'from' => array(
'email' => '[email protected]',
'name' => 'string'
),
'subject' => 'string',
'previewTitle' => 'string',
'idTemplateMailUser' => number,
'params' => array(
'test' => 'string',
'test1' => 'string',
'test2' => 'string'
)
)
);
$headers = array(
'Content-Type' => 'application/json',
'X-Api-Key' => 'YOUR_API_KEY'
);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
import requests
import json
url = 'https://api.emailmassivo.com/api/v1/external-mails/send-by-template'
data = {
'idempotencyKey': 'unique-key-string',
'mail': {
'to': {
'email': '[email protected]',
'name': 'string'
},
'from': {
'email': '[email protected]',
'name': 'string'
},
'subject': 'string',
'previewTitle': 'string',
'idTemplateMailUser': number,
'params': {
'test': 'string',
'test1': 'string',
'test2': 'string'
}
}
}
headers = {
'Content-Type': 'application/json',
'X-Api-Key': 'YOUR_API_KEY'
}
response = requests.post(url, json=data, headers=headers)
const axios = require('axios');
const url = 'https://api.emailmassivo.com/api/v1/external-mails/send-by-template';
const data = {
idempotencyKey: 'unique-key-string',
mail: {
to: {
email: '[email protected]',
name: 'string'
},
from: {
email: '[email protected]',
name: 'string'
},
subject: 'string',
previewTitle: 'string',
idTemplateMailUser: number,
params: {
test: 'string',
test1: 'string',
test2: 'string'
}
}
};
const headers = {
'Content-Type': 'application/json',
'X-Api-Key': 'YOUR_API_KEY'
};
axios.post(url, data, { headers })
.then(response => {
// Processamento de resposta API
})
.catch(error => {
// Processamento de erro
});
const url = 'https://api.emailmassivo.com/api/v1/external-mails/send-by-template';
const data = {
idempotencyKey: 'unique-key-string',
mail: {
to: {
email: '[email protected]',
name: 'string'
},
from: {
email: '[email protected]',
name: 'string'
},
subject: 'string',
previewTitle: 'string',
idTemplateMailUser: number,
params: {
test: 'string',
test1: 'string',
test2: 'string'
}
}
};
const headers = {
'Content-Type': 'application/json',
'X-Api-Key': 'YOUR_API_KEY'
};
fetch(url, {
method: 'POST',
headers: headers,
body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => {
// Processamento de resposta API
})
.catch(error => {
// Processamento de erro
});
Se a solicitação retornar um erro: «Chave API incorreta», substitua o código de transmissão de API key por:
$headers = array( 'Content-Type: application/json', 'X-Api-Key: YOUR_API_KEY');