Tags

Tags são pares { name, value } anexados a um e-mail. Elas são armazenadas com o e-mail, retornadas por GET /emails/{id} e repetidas em todo payload de webhook desse e-mail (como um objeto, "tags": { "category": "welcome" }). Use-as para ligar os eventos aos seus próprios registros sem precisar guardar o id do SpacePost.

import { SpacePost } from "@spacepost/node";

const spacepost = new SpacePost(process.env.SPACEPOST_API_KEY);

await spacepost.emails.send({
  from: "Acme <hello@acme.com>",
  to: "user@example.com",
  subject: "Welcome",
  html: "<p>Hi</p>",
  tags: [
    { name: "category", value: "welcome" },
    { name: "user_id", value: "u_1042" },
  ],
});

curl -X POST https://api.spacepost.dev/emails \
  -H "Authorization: Bearer $SPACEPOST_API_KEY" -H "Content-Type: application/json" \
  -d '{
    "from": "Acme <hello@acme.com>",
    "to": ["user@example.com"],
    "subject": "Welcome",
    "html": "<p>Hi</p>",
    "tags": [{ "name": "category", "value": "welcome" }, { "name": "user_id", "value": "u_1042" }]
  }'

X-SpacePost-Tags: category=welcome, user_id=u_1042

Regras

Até 50 tags por e-mail.
name e value têm, cada um, de 1 a 256 caracteres e só podem conter letras ASCII, números, sublinhados e hifens (A-Z a-z 0-9 _ -).
Espaços, pontos, @ e caracteres não ASCII são rejeitados com um 422. Aplique hash ou slug em valores como endereços de e-mail antes, por exemplo user_1042 ou um digest hexadecimal SHA-256.