メインコンテンツへ
BlueAI
BlueAIBlueAI API
JAEN
ホーム/CRM（顧客管理）/タグ

タグ（Tags）

案件・会社・連絡先に付与するタグの管理と、タグによるリソースの絞り込みを行います。

|

エンドポイント

GET/api/v1/crm/tagsタグ一覧を取得
POST/api/v1/crm/tagsタグを作成
PATCH/api/v1/crm/tags/{id}タグを更新
DELETE/api/v1/crm/tags/{id}タグを削除
POST/api/v1/crm/tag-assignmentsリソースにタグを付与
DELETE/api/v1/crm/tag-assignments/{tag_id}タグを解除
GET/api/v1/crm/tags

タグ一覧を取得

組織内のすべてのタグを取得します。

認証が必要です— セッション Cookie または Bearer トークンを含めてください

レスポンスフィールド

名前型必須説明
Tag[]任意タグの配列

コード例

curl "https://api.blueai.jp/api/v1/crm/tags" \
  -H "Cookie: better-auth.session_token=<token>"

レスポンス例

{
  "tags": [
    {
      "id": "tag_f1f1f1f1f1f1f1f1f1f1f1f1f1f1f1f1",
      "name": "重要顧客",
      "color": "#EF4444",
      "created_at": "2026-01-15T09:00:00Z",
      "updated_at": "2026-01-15T09:00:00Z"
    },
    {
      "id": "tag_f2f2f2f2f2f2f2f2f2f2f2f2f2f2f2f2",
      "name": "新規開拓",
      "color": "#3B82F6",
      "created_at": "2026-01-20T10:00:00Z",
      "updated_at": "2026-01-20T10:00:00Z"
    }
  ]
}
POST/api/v1/crm/tags

タグを作成

新しいタグを作成します。タグ名は組織内で一意である必要があります。

認証が必要です— セッション Cookie または Bearer トークンを含めてください

リクエストボディ

名前型必須説明
name
string必須タグ名
color
string必須タグの色（HEX カラーコード、例: #EF4444）

レスポンスフィールド

名前型必須説明
tag
Tag任意作成されたタグ

コード例

curl -X POST "https://api.blueai.jp/api/v1/crm/tags" \
  -H "Cookie: better-auth.session_token=<token>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "重要顧客",
  "color": "#EF4444"
}'

レスポンス例

{
  "tag": {
    "id": "tag_f1f1f1f1f1f1f1f1f1f1f1f1f1f1f1f1",
    "name": "重要顧客",
    "color": "#EF4444",
    "created_at": "2026-02-20T09:00:00Z",
    "updated_at": "2026-02-20T09:00:00Z"
  }
}
PATCH/api/v1/crm/tags/{id}

タグを更新

指定したタグの名前や色を更新します。

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前型必須説明
id
string必須タグ ID

リクエストボディ

名前型必須説明
name
string任意タグ名
color
string任意タグの色（HEX カラーコード）

レスポンスフィールド

名前型必須説明
tag
Tag任意更新後のタグ

コード例

curl -X PATCH "https://api.blueai.jp/api/v1/crm/tags/tag_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VIP 顧客",
  "color": "#F59E0B"
}'

レスポンス例

{
  "tag": {
    "id": "tag_f1f1f1f1f1f1f1f1f1f1f1f1f1f1f1f1",
    "name": "VIP 顧客",
    "color": "#F59E0B",
    "created_at": "2026-01-15T09:00:00Z",
    "updated_at": "2026-02-20T11:00:00Z"
  }
}
DELETE/api/v1/crm/tags/{id}

タグを削除

指定したタグを削除します。リソースに付与されているタグの関連付けも同時に解除されます。

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前型必須説明
id
string必須タグ ID

レスポンスフィールド

名前型必須説明
success
boolean任意削除成功フラグ

コード例

curl -X DELETE "https://api.blueai.jp/api/v1/crm/tags/tag_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"

レスポンス例

{
  "success": true
}
POST/api/v1/crm/tag-assignments

リソースにタグを付与

案件・会社・連絡先にタグを付与します。resource_type は deal / company / contact のいずれかです。

認証が必要です— セッション Cookie または Bearer トークンを含めてください

リクエストボディ

名前型必須説明
tag_id
string必須付与するタグの ID
resource_type
string必須リソース種別（deal / company / contact）
resource_id
string必須リソース ID

レスポンスフィールド

名前型必須説明
TagAssignment任意作成されたタグ割り当て

コード例

curl -X POST "https://api.blueai.jp/api/v1/crm/tag-assignments" \
  -H "Cookie: better-auth.session_token=<token>" \
  -H "Content-Type: application/json" \
  -d '{
  "tag_id": "tag_f1f1f1f1f1f1f1f1f1f1f1f1f1f1f1f1",
  "resource_type": "deal",
  "resource_id": "deal_11111111111111111111111111111111"
}'

レスポンス例

{
  "assignment": {
    "id": "taga_abababababababababababababababab",
    "tag_id": "tag_f1f1f1f1f1f1f1f1f1f1f1f1f1f1f1f1",
    "resource_type": "deal",
    "resource_id": "deal_11111111111111111111111111111111",
    "tag_name": "重要顧客",
    "tag_color": "#EF4444",
    "created_at": "2026-02-20T10:00:00Z"
  }
}
DELETE/api/v1/crm/tag-assignments/{tag_id}

タグを解除

リソースからタグの割り当てを解除します。resource_type と resource_id をクエリパラメータで指定します。

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前型必須説明
tag_id
string必須タグ ID

クエリパラメータ

名前型必須説明
resource_type
string任意リソース種別（deal / company / contact）
resource_id
string任意リソース ID

レスポンスフィールド

名前型必須説明
success
boolean任意削除成功フラグ

コード例

curl -X DELETE "https://api.blueai.jp/api/v1/crm/tag-assignments/:tag_id" \
  -H "Cookie: better-auth.session_token=<token>"

レスポンス例

{
  "success": true
}