タグ
タグは、メールに付ける { name, value } のペアです。メールとともに保存され、GET /emails/{id} で返され、そのメールのWebhook ペイロードにもすべて含まれます(オブジェクトとして、"tags": { "category": "welcome" })。SpacePost の id を保存しなくても、イベントを自社のレコードに結び付けられます。
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- 1 通のメールにつき最大 50 個のタグ。
nameとvalueはそれぞれ 1 〜 256 文字で、使えるのは ASCII の英字、数字、アンダースコア、ダッシュ(A-Z a-z 0-9 _ -)だけです。- スペース、ドット、
@、非 ASCII 文字は422で拒否されます。メールアドレスのような値は、先にハッシュ化するかスラッグにしてください。たとえばuser_1042や SHA-256 の 16 進ダイジェストです。