APIでユーザーに特定のタグを追加する

できること

貴社の顧客基盤（CDPやCRMツールなど）で条件に合うユーザーを抽出し、「end_users/tags/attach」APIを実行することで、Message Managerの対象ユーザーへ直接タグを付与できます。

付与したタグを利用することで、セグメント配信やトリガー配信、リッチメニューの出し分けなどが可能です。

‍

使用するAPI

「end_users/tags/attach」API

‍

API リファレンス

指定したタグをエンドユーザーに付与します。

POST /v2/end_users/tags/attach

‍

リクエストパラメータ

‍

Body Parameters

‍

EndUser オブジェクト

‍

Identifier オブジェクト

‍

エラーコード

エラー定義 参照。

‍

レスポンス

成功時

成功時に ステータスコード 200 OK と以下のプロパティを含む JSON オブジェクトを返します。

‍

Response Body

‍

EndUser オブジェクト

‍

Identifier オブジェクト

‍

レスポンス例

{
  "end_user": {
    "identifiers": [
      {
        "type": "line_uid",
        "value": "U0123456789abcdef0123456789abcdef"
      },
      {
        "type": "socialplus_uid",
        "value": "wx6nk13a3j8rc7400n4x"
      },
      {
        "type": "primary_key",
        "value": null
      }
    ],
    "tags": ["tag1", "tag2", "tag3"]
  }
}

‍

エンドユーザーが存在しない場合

ステータスコード 404 Not Found とともに、以下の内容を返します。

{
  "errors": [
    {
      "path": "__global__",
      "code": "resource_not_found"
    }
  ]
}

‍

指定するタグが不正な場合

ステータスコード 400 Bad Request とともに、以下の内容を返します。

{
  "errors": [
    {
      "path": "__global__",
      "code": "invalid_parameter"
    }
  ]
}

‍

• 不正な文字列
  • カンマ
  • 文字列の前後に空白
• タグの文字数が 255 文字以上

‍

実行サンプル

curl -L -X POST https://msgapi.socialplus.jp/v2/end_users/tags/attach \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Accept: application/json' \
  -H "X-API-Key: {API Key}" \
  --data-raw '{
    "end_user": {
      "identifier": {
        "type": "line_uid",
        "value": "U01234567890123456789012345678901"
      },
      "tag": "tag"
    }
  }'

‍