ブランド設定

Management API によって公開される 7 つの保存された組織ブランドフィールドを管理します。 Hosted Auth ランタイムアプリケーションとカスタム CSS は同梱されていません。

ブランド設定オプション

Management API は、組織スコープの 7 つのブランド値を KV に保存します。認証済みの管理クライアントで利用できますが、Hosted Auth とメールへの自動反映は実装されていません。

オプション	説明
プライマリカラー	管理クライアント用に保存されたプライマリカラー値。
背景色	管理クライアント用に保存されたページの背景値。
アクセントカラー	管理クライアント用に保存されたアクセントカラー値。
角丸	保存された border-radius 値。API は特定の名前付きスケールに制限しません。
フォントファミリー	保存されたフォントファミリーの値。 API はリモートフォントの取得や検証を行いません。
ロゴ（ライト）	保存されたライトテーマのロゴ URL。組織のロゴのアップロードは、R2 を利用した別のエンドポイントです。
ロゴ（ダーク）	保存されたダークテーマのロゴ URL。この API は自動フォールバックを適用しません。

組織ごとのブランド設定

各レコードは、KV のテナントと組織によってキー付けされます。レコードが存在しない場合、読み取りでは 7 つのフィールドすべてが null 値で返されます。実行時のレンダリングや遅延の保証は含まれません。

Management API エンドポイント

キャメルケースのフィールド名を使用した PATCH リクエストで組織のブランドを更新します。省略されたフィールドと null は現在、保存されている値を保持します。置換文字列を送信してフィールドを変更します。

curl -X PATCH https://xid.dev/v1/organizations/org_xxx/branding \
  -H 'Authorization: Bearer sk_live_xxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "primaryColor": "#6366f1",
    "borderRadius": "0.5rem",
    "fontFamily": "Inter, sans-serif",
    "logoUrl": "https://cdn.example.com/logo.svg"
  }'

検証境界

ブランドスキーマは、上記の 7 つのフィールドのみを受け入れます。カスタム CSS は受け入れられません。
エンドポイントがスタイルシートを受け入れないため、@import および url() CSS 処理は実装されていません。
値は文字列として保存されます。色、半径、フォント、URL の構文は JSON 型の検証以外では確認されません。
iframe プレビューや個別のドラフトと公開された状態はありません。

電子メールテンプレートの境界

トランザクションメールでは、組み込みの Mustache テンプレートとグローバル R2 ロケールパックを使用します。組織ごとの HTML テンプレートのアップロードとブランド情報の自動挿入は実装されていません。