API-referentie

Uitsluitingslijst

De uitsluitingslijst bevat de mensen die Gemlead nooit benadert, op X-account of op domein, zoals je klanten, je team of een concurrent. Een lead op de lijst komt nooit in een campagne. De lijst heeft plaats voor 5 000 items.

Elke persona heeft ook een eigen lijst, die je kiest met persona. Die geldt op elk X-account dat de persona deelt. Een lead blijft buiten beeld als hij op de lijst van zijn persona staat of op die van zijn X-account.

Endpoints

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

Het uitsluitingslijst-object

De X-accounts en domeinen die Gemlead nooit benadert, zoals je klanten, je team of een concurrent. Een lead op de lijst, via zijn gebruikersnaam of het domein op zijn profiel, komt nooit in een campagne.

Attributen

objectstring
Altijd exclusion_list.
persona_idstring of null
De persona waarvan dit de eigen lijst is, of null voor de lijst van het X-account.
handlesarray van strings
X-gebruikersnamen, zonder de @.
domainsarray van strings
Domeinen, zoals bigcustomer.com. Een e-mailadres voegt het bijbehorende domein toe.
max_entriesinteger
Hoeveel items de lijst maximaal bevat.

Het uitsluitingslijst-object

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

De uitsluitingslijst ophalen

GET/v1/exclusion_listScope readMCPget_exclusion_list

Geeft alle X-accounts en domeinen op de lijst terug.

Queryparameters

personastring
De ID van een persona, om met de eigen lijst van die persona te werken. Zonder deze parameter werk je met de lijst van het X-account.

Resultaat

Het uitsluitingslijst-object.

Fouten

404resource_missing
Geen persona met deze ID op het account van de sleutel.

GET/v1/exclusion_list

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

Response200

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

Toevoegen aan de uitsluitingslijst

POST/v1/exclusion_list/addScope writeMCPedit_exclusion_list

Voegt X-accounts of domeinen toe aan de lijst. Leads die overeenkomen, stoppen in elke campagne.

Bodyparameters

entriesarray van stringsVerplicht
1 tot 500 items. Elk een @gebruikersnaam, een profiel-URL op x.com, een domein of een e-mailadres voor het domein ervan.
personastring
De ID van een persona, om met de eigen lijst van die persona te werken. Zonder deze parameter werk je met de lijst van het X-account.

Resultaat

Het bijgewerkte uitsluitingslijst-object.

Fouten

400parameter_missing
Er ontbreekt een verplichte parameter. param geeft aan welke.
400parameter_invalid
Een parameter heeft een waarde die de API niet accepteert. param geeft aan welke.
404resource_missing
Geen persona met deze ID op het account van de sleutel.
400limit_reached
De lijst zou meer dan 5 000 items bevatten.

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"]
  }'

Response200

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

Verwijderen van de uitsluitingslijst

POST/v1/exclusion_list/removeScope writeMCPedit_exclusion_list

Haalt X-accounts of domeinen van de lijst.

Bodyparameters

entriesarray van stringsVerplicht
1 tot 500 items, zoals ze in de lijst staan.
personastring
De ID van een persona, om met de eigen lijst van die persona te werken. Zonder deze parameter werk je met de lijst van het X-account.

Resultaat

Het bijgewerkte uitsluitingslijst-object.

Fouten

400parameter_missing
Er ontbreekt een verplichte parameter. param geeft aan welke.
400parameter_invalid
Een parameter heeft een waarde die de API niet accepteert. param geeft aan welke.
404resource_missing
Een item staat niet op de lijst, of er is geen persona met deze 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"]
  }'

Response200

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