APIでセグメントからユーザーを削除

設定マニュアル MENUを表示する

できること

貴社の顧客基盤（CDPやCRMツールなど）で条件に合うユーザーを抽出し、「end_users/remove」APIを実行することで、Message ManagerのセグメントグループからユーザーIDを削除できます。

ユーザーの状態変更や条件変更に応じて、セグメントを最新の状態に保つことが可能です。

‍

使用するAPI

「end_users/remove」API

‍

API リファレンス

指定したセグメント（ID を指定）からエンドユーザーを削除します。

POST /v2/end_user_segments/:identifier/list/end_users/remove

‍

リクエストパラメータ

‍

Path Parameters

パラメータ名	型	必須	説明
identifier	string	○	セグメント（IDを指定）を一意に表す識別子

‍

Body Parameters

パラメータ名	型	必須	説明
end_user	object	○	EndUser オブジェクトを指定

‍

EndUser オブジェクト

パラメータ名	型	必須	説明
identifier	object	○	Identifier オブジェクトを指定

‍

Identifier オブジェクト

パラメータ名	型	必須	説明
type	string	○	エンドユーザーの識別子のタイプ。`socialplus_uid`, `primary_key`,`line_uid` のいずれかを指定
value	string	○	エンドユーザーの識別子

‍

エラーコード

エラー定義参照。

‍

レスポンス

‍

成功時

成功時にステータスコード 200 OK と空の JSON オブジェクトを返します。

レスポンス例

{}

‍

指定された識別子に対応するセグメントが存在しない場合

ステータスコード 404 Not Found とともに、以下の内容を返します。指定されたセグメントが「エンドユーザーの ID のリストを管理するセグメントでない場合」「利用可能状態でない場合」も同じエラーを返します。

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

‍

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

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

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

‍

実行サンプル

curl -L -X POST https://msgapi.socialplus.jp/v2/end_user_segments/{identifier}/list/end_users/remove \
  -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"
      }
    }
  }'

‍