コンテンツにスキップ

タグ

タグは、メールに付ける { name, value } のペアです。メールとともに保存され、GET /emails/{id} で返され、そのメールのWebhook ペイロードにもすべて含まれます(オブジェクトとして、"tags": { "category": "welcome" })。SpacePost の id を保存しなくても、イベントを自社のレコードに結び付けられます。

tags.ts
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" },
],
});
  • 1 通のメールにつき最大 50 個のタグ。
  • name と value はそれぞれ 1 〜 256 文字で、使えるのは ASCII の英字、数字、アンダースコア、ダッシュ(A-Z a-z 0-9 _ -)だけです。
  • スペース、ドット、@、非 ASCII 文字は 422 で拒否されます。メールアドレスのような値は、先にハッシュ化するかスラッグにしてください。たとえば user_1042 や SHA-256 の 16 進ダイジェストです。