API-Referenz

Ausschlussliste

Die Ausschlussliste enthält die Leute, die Gemlead nie kontaktiert, per X-Konto oder per Domain, etwa deine Kunden, dein Team oder einen Konkurrenten. Ein Lead auf der Liste kommt nie in eine Kampagne. Die Liste fasst 5 000 Einträge.

Jede Persona hat außerdem ihre eigene Liste, die du über persona ansprichst. Sie gilt in jedem X-Konto, das die Persona teilt. Ein Lead bleibt außen vor, wenn er auf der Liste seiner Persona oder seines X-Kontos steht.

Endpoints

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

Das Ausschlusslisten-Objekt

Die X-Konten und Domains, die Gemlead nie kontaktiert, etwa deine Kunden, dein Team oder einen Konkurrenten. Ein Lead, der über seinen Nutzernamen oder die Domain in seinem Profil auf der Liste steht, kommt nie in eine Kampagne.

Attribute

objectstring
Immer exclusion_list.
persona_idstring oder null
Die Persona, der diese Liste gehört, oder null für die Liste des X-Kontos.
handlesArray von strings
X-Nutzernamen, ohne @.
domainsArray von strings
Domains, etwa bigcustomer.com. Eine E-Mail-Adresse fügt ihre Domain hinzu.
max_entriesinteger
Wie viele Einträge die Liste höchstens fasst.

Das Ausschlusslisten-Objekt

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

Ausschlussliste abrufen

GET/v1/exclusion_listScope readMCPget_exclusion_list

Gibt alle X-Konten und Domains auf der Liste zurück.

Query-Parameter

personastring
Die ID einer Persona, um mit ihrer eigenen Liste zu arbeiten. Ohne sie die Liste des X-Kontos.

Rückgabe

Das Ausschlusslisten-Objekt.

Fehler

404resource_missing
Keine Persona mit dieser ID im Konto des Schlüssels.

GET/v1/exclusion_list

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

Antwort200

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

Zur Ausschlussliste hinzufügen

POST/v1/exclusion_list/addScope writeMCPedit_exclusion_list

Fügt der Liste X-Konten oder Domains hinzu. Passende Leads stoppen in jeder Kampagne.

Body-Parameter

entriesArray von stringsErforderlich
1 bis 500 Einträge. Jeder ist ein @Nutzername, eine x.com-Profil-URL, eine Domain oder eine E-Mail-Adresse, deren Domain übernommen wird.
personastring
Die ID einer Persona, um mit ihrer eigenen Liste zu arbeiten. Ohne sie die Liste des X-Kontos.

Rückgabe

Das aktualisierte Ausschlusslisten-Objekt.

Fehler

400parameter_missing
Ein Pflichtparameter fehlt. param nennt ihn.
400parameter_invalid
Ein Parameter hat einen Wert, den die API nicht akzeptiert. param nennt ihn.
404resource_missing
Keine Persona mit dieser ID im Konto des Schlüssels.
400limit_reached
Die Liste hätte dann mehr als 5 000 Einträge.

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

Antwort200

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

Von der Ausschlussliste entfernen

POST/v1/exclusion_list/removeScope writeMCPedit_exclusion_list

Nimmt X-Konten oder Domains von der Liste.

Body-Parameter

entriesArray von stringsErforderlich
1 bis 500 Einträge, so wie sie aufgelistet sind.
personastring
Die ID einer Persona, um mit ihrer eigenen Liste zu arbeiten. Ohne sie die Liste des X-Kontos.

Rückgabe

Das aktualisierte Ausschlusslisten-Objekt.

Fehler

400parameter_missing
Ein Pflichtparameter fehlt. param nennt ihn.
400parameter_invalid
Ein Parameter hat einen Wert, den die API nicht akzeptiert. param nennt ihn.
404resource_missing
Ein Eintrag steht nicht auf der Liste, oder keine Persona hat diese 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"]
  }'

Antwort200

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