ホーム/ガイド/メタデータ

メタデータ

リソースにカスタムデータを付与する方法。

概要

一部のリソース（CRM の案件・連絡先・会社など）は metadata フィールドをサポートしています。metadata は任意の key-value ペアを格納できる JSON オブジェクトで、外部システムとの連携や独自の分類に利用できます。

メタデータの設定

リソースの作成時または更新時に metadata フィールドに JSON オブジェクトを渡します。既存のメタデータは新しい値で完全に上書きされます。

curl -X POST https://api.blueai.jp/api/v1/crm/deals \
  -H "Content-Type: application/json" \
  -b cookies.txt \
  -d '{
    "name": "New Deal",
    "metadata": {
      "source": "website",
      "campaign_id": "camp_123e4567e89b12d3a456426614174000",
      "priority": "high"
    }
  }'

メタデータの取得

リソースの取得時に metadata フィールドが含まれます。

{
  "id": "deal_11111111111111111111111111111111",
  "name": "New Deal",
  "metadata": {
    "source": "website",
    "campaign_id": "camp_123e4567e89b12d3a456426614174000",
    "priority": "high"
  }
}

制限事項

metadata のサイズは最大 16 KB です。キーは最大 40 文字、値は文字列で最大 500 文字です。最大 50 個のキーを格納できます。

使用例

// Set metadata on a deal
const res = await fetch("https://api.blueai.jp/api/v1/crm/deals/deal_11111111111111111111111111111111", {
  method: "PUT",
  headers: { "Content-Type": "application/json" },
  credentials: "include",
  body: JSON.stringify({
    metadata: {
      source: "referral",
      external_id: "ext_456",
    },
  }),
});