Saltar para a documentação
API

Criar uma assinatura

Acrescentar uma assinatura com nome a um endereço ou a um catch-all.

POST/signatures

Executa a chamada real no seu espaço de trabalho.

POST /signatures

Acrescentar uma assinatura com nome a um endereço ou a um catch-all.

Exemplo

Requer settings:write. address, name e html são obrigatórios.

curl
curl -X POST "$OE/signatures" -H "$AUTH" -H "Content-Type: application/json" \  -d '{    "address": "[email protected]",    "name": "Short",    "html": "<p>Ada<br>Acme Ltd</p>",    "isReplyDefault": true  }'
Resposta
{  "object": "signature",  "id": "sig_8f2c1a9b7d3e4f60a1b2c3d4",  "address": "[email protected]",  "name": "Short",  "html": "<p>Ada<br />Acme Ltd</p>",  "isDefault": false,  "isReplyDefault": true,  "createdAt": "2026-10-12T09:14:03.117Z",  "updatedAt": "2026-10-12T09:14:03.117Z"}

O HTML é limpo da mesma forma que o correio enviado, por isso o que volta pode ser diferente do que enviou, e tem de manter algum texto ou uma imagem. Aceita no máximo 150.000 caracteres, antes e depois da limpeza, ou a chamada é um 422 signature_too_long.

A primeira assinatura de um endereço passa a ser a predefinida para correio novo e para respostas, a menos que isDefault ou isReplyDefault diga false. Uma posterior só passa a predefinida quando isso é pedido, e nesse caso tira esse lugar à assinatura que o tinha.

name tem de 1 a 80 caracteres e é único no seu endereço, sem distinguir maiúsculas. Um nome que o endereço já usa é um 409 signature_name_taken. Um endereço tem no máximo 50 assinaturas, e a seguinte é um 422 signature_limit_reached.

O endereço tem de ser um do espaço de trabalho, ou um catch-all de um domínio verificado aqui com o catch-all ligado. Qualquer outra coisa, incluindo um domínio inteiro, é um 422 invalid_parameter.

Referência