Référence API

Liste d'exclusion

La liste d'exclusion contient les personnes que Gemlead ne contacte jamais, par compte X ou par domaine, comme tes clients, ton équipe ou un concurrent. Un lead qui y figure n'entre jamais dans une campagne. La liste contient jusqu'à 5 000 entrées.

Chaque persona a aussi sa propre liste, ciblée avec persona. Elle s'applique sur chaque compte X qui partage le persona. Un lead est écarté s'il figure sur la liste de son persona ou sur celle de son compte X.

Endpoints

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

L'objet liste d'exclusion

Les comptes X et les domaines que Gemlead ne contacte jamais, comme tes clients, ton équipe ou un concurrent. Un lead sur la liste, par son nom d'utilisateur ou le domaine de son profil, n'entre jamais dans une campagne.

Attributs

objectstring
Toujours exclusion_list.
persona_idstring ou null
Le persona à qui appartient cette liste, ou null pour la liste du compte X.
handlestableau de strings
Des noms d'utilisateur X, sans le @.
domainstableau de strings
Des domaines, comme bigcustomer.com. Un email ajoute son domaine.
max_entriesinteger
Le nombre maximum d'entrées de la liste.

L'objet liste d'exclusion

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

Récupérer la liste d'exclusion

GET/v1/exclusion_listScope readMCPget_exclusion_list

Renvoie tous les comptes X et domaines de la liste.

Paramètres de requête

personastring
L'ID d'un persona, pour agir sur la liste propre à ce persona. Sans lui, la liste du compte X.

Renvoie

L'objet liste d'exclusion.

Erreurs

404resource_missing
Aucun persona avec cet ID sur le compte de la clé.

GET/v1/exclusion_list

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

Réponse200

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

Ajouter à la liste d'exclusion

POST/v1/exclusion_list/addScope writeMCPedit_exclusion_list

Ajoute des comptes X ou des domaines à la liste. Les leads qui correspondent sortent de toutes les campagnes.

Paramètres du corps

entriestableau de stringsObligatoire
De 1 à 500 entrées. Chaque entrée est un @username, une URL de profil x.com, un domaine, ou un email dont on prend le domaine.
personastring
L'ID d'un persona, pour agir sur la liste propre à ce persona. Sans lui, la liste du compte X.

Renvoie

L'objet liste d'exclusion à jour.

Erreurs

400parameter_missing
Il manque un paramètre obligatoire. param indique lequel.
400parameter_invalid
Un paramètre a une valeur que l'API n'accepte pas. param indique lequel.
404resource_missing
Aucun persona avec cet ID sur le compte de la clé.
400limit_reached
La liste dépasserait 5 000 entrées.

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

Réponse200

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

Retirer de la liste d'exclusion

POST/v1/exclusion_list/removeScope writeMCPedit_exclusion_list

Retire des comptes X ou des domaines de la liste.

Paramètres du corps

entriestableau de stringsObligatoire
De 1 à 500 entrées, telles que la liste les renvoie.
personastring
L'ID d'un persona, pour agir sur la liste propre à ce persona. Sans lui, la liste du compte X.

Renvoie

L'objet liste d'exclusion à jour.

Erreurs

400parameter_missing
Il manque un paramètre obligatoire. param indique lequel.
400parameter_invalid
Un paramètre a une valeur que l'API n'accepte pas. param indique lequel.
404resource_missing
Une entrée ne figure pas sur la liste, ou aucun persona n'a cet 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"]
  }'

Réponse200

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