APIリファレンス

除外リスト

除外リストには、顧客、チームのメンバー、競合など、Gemleadが一切連絡しない相手をXアカウントまたはドメインで登録します。リストに含まれるリードがキャンペーンに追加されることはありません。リストには5 000件まで登録できます。

各ペルソナには専用のリストもあり、personaで指定します。このリストは、ペルソナを共有するすべてのXアカウントで有効です。リードは、そのペルソナのリストかXアカウントのリストに含まれていれば対象外になります。

エンドポイント

GET/v1/exclusion_list
POST/v1/exclusion_list/add
POST/v1/exclusion_list/remove

除外リストオブジェクト

顧客、チームのメンバー、競合など、Gemleadが一切連絡しないXアカウントとドメイン。ユーザー名またはプロフィールのドメインがリストに一致するリードは、キャンペーンに追加されません。

属性

objectstring
常にexclusion_listです。
persona_idstringまたはnull
このリストを持つペルソナ。Xアカウントのリストならnullです。
handlesstringsの配列
Xのユーザー名。@は含みません。
domainsstringsの配列
bigcustomer.comのようなドメイン。メールアドレスを指定すると、そのドメインが追加されます。
max_entriesinteger
リストに登録できる件数の上限。

除外リストオブジェクト

{
  "object": "exclusion_list",
  "persona_id": null,
  "handles": ["competitor_hq", "my_cofounder"],
  "domains": ["bigcustomer.com"],
  "max_entries": 5000
}

除外リストを取得

GET/v1/exclusion_listreadスコープMCPget_exclusion_list

リストに登録されたすべてのXアカウントとドメインを返します。

クエリパラメーター

personastring
ペルソナのID。そのペルソナ専用のリストを操作します。指定しない場合はXアカウントのリストです。

戻り値

除外リストオブジェクト。

エラー

404resource_missing
キーのアカウントに、このIDのペルソナはありません。

GET/v1/exclusion_list

curl https://gemlead.ai/api/v1/exclusion_list \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"

レスポンス200

{
  "object": "exclusion_list",
  "persona_id": null,
  "handles": ["competitor_hq", "my_cofounder"],
  "domains": ["bigcustomer.com"],
  "max_entries": 5000
}

除外リストに追加

POST/v1/exclusion_list/addwriteスコープMCPedit_exclusion_list

Xアカウントまたはドメインをリストに追加します。一致するリードは、すべてのキャンペーンで停止します。

ボディパラメーター

entriesstringsの配列必須
1件から500件のエントリ。それぞれ@ユーザー名、x.comのプロフィールURL、ドメイン、またはドメインを追加するためのメールアドレスです。
personastring
ペルソナのID。そのペルソナ専用のリストを操作します。指定しない場合はXアカウントのリストです。

戻り値

更新された除外リストオブジェクト。

エラー

400parameter_missing
必須パラメーターがありません。paramにその名前が入ります。
400parameter_invalid
APIが受け付けない値のパラメーターがあります。paramにその名前が入ります。
404resource_missing
キーのアカウントに、このIDのペルソナはありません。
400limit_reached
リストが5 000件を超えてしまいます。

POST/v1/exclusion_list/add

curl -X POST https://gemlead.ai/api/v1/exclusion_list/add \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entries": ["@competitor_hq", "bigcustomer.com"]
  }'

レスポンス200

{
  "object": "exclusion_list",
  "persona_id": null,
  "handles": ["competitor_hq", "my_cofounder"],
  "domains": ["bigcustomer.com"],
  "max_entries": 5000
}

除外リストから削除

POST/v1/exclusion_list/removewriteスコープMCPedit_exclusion_list

Xアカウントまたはドメインをリストから外します。

ボディパラメーター

entriesstringsの配列必須
1件から500件のエントリ。一覧に表示されているとおりに指定します。
personastring
ペルソナのID。そのペルソナ専用のリストを操作します。指定しない場合はXアカウントのリストです。

戻り値

更新された除外リストオブジェクト。

エラー

400parameter_missing
必須パラメーターがありません。paramにその名前が入ります。
400parameter_invalid
APIが受け付けない値のパラメーターがあります。paramにその名前が入ります。
404resource_missing
リストにないエントリが含まれているか、このIDのペルソナがありません。

POST/v1/exclusion_list/remove

curl -X POST https://gemlead.ai/api/v1/exclusion_list/remove \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entries": ["my_cofounder"]
  }'

レスポンス200

{
  "object": "exclusion_list",
  "persona_id": null,
  "handles": ["competitor_hq"],
  "domains": ["bigcustomer.com"],
  "max_entries": 5000
}