Riferimento API

Lista di esclusione

La lista di esclusione contiene le persone che Gemlead non contatta mai, per account X o per dominio, come i tuoi clienti, il tuo team o un concorrente. Un lead in lista non entra mai in una campagna. La lista può contenere fino a 5 000 voci.

Anche ogni buyer persona ha la sua lista, da indicare con persona. Vale su ogni account X che condivide la buyer persona. Un lead resta fuori se è nella lista della sua buyer persona o in quella del suo account X.

Endpoint

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

L'oggetto lista di esclusione

Gli account X e i domini che Gemlead non contatta mai, come i tuoi clienti, il tuo team o un concorrente. Un lead in lista, per il suo username o per il dominio sul suo profilo, non entra mai in una campagna.

Attributi

objectstring
Sempre exclusion_list.
persona_idstring o null
La buyer persona a cui appartiene questa lista, o null per la lista dell'account X.
handlesarray di strings
Username X, senza la @.
domainsarray di strings
Domini, come bigcustomer.com. Un'email aggiunge il suo dominio.
max_entriesinteger
Quante voci contiene al massimo la lista.

L'oggetto lista di esclusione

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

Recupera la lista di esclusione

GET/v1/exclusion_listScope readMCPget_exclusion_list

Restituisce tutti gli account X e i domini in lista.

Parametri di query

personastring
L'ID di una buyer persona, per lavorare sulla sua lista. Senza, la lista dell'account X.

Restituisce

L'oggetto lista di esclusione.

Errori

404resource_missing
Nessuna buyer persona con questo ID sull'account della chiave.

GET/v1/exclusion_list

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

Risposta200

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

Aggiungi alla lista di esclusione

POST/v1/exclusion_list/addScope writeMCPedit_exclusion_list

Aggiunge account X o domini alla lista. I lead che corrispondono si fermano in ogni campagna.

Parametri del body

entriesarray di stringsObbligatorio
Da 1 a 500 voci. Ognuna è un @username, l'URL di un profilo x.com, un dominio o un'email per il suo dominio.
personastring
L'ID di una buyer persona, per lavorare sulla sua lista. Senza, la lista dell'account X.

Restituisce

L'oggetto lista di esclusione aggiornato.

Errori

400parameter_missing
Manca un parametro obbligatorio. param lo indica.
400parameter_invalid
Un parametro ha un valore che l'API non accetta. param lo indica.
404resource_missing
Nessuna buyer persona con questo ID sull'account della chiave.
400limit_reached
La lista conterrebbe più di 5 000 voci.

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

Risposta200

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

Rimuovi dalla lista di esclusione

POST/v1/exclusion_list/removeScope writeMCPedit_exclusion_list

Toglie account X o domini dalla lista.

Parametri del body

entriesarray di stringsObbligatorio
Da 1 a 500 voci, come sono elencate.
personastring
L'ID di una buyer persona, per lavorare sulla sua lista. Senza, la lista dell'account X.

Restituisce

L'oggetto lista di esclusione aggiornato.

Errori

400parameter_missing
Manca un parametro obbligatorio. param lo indica.
400parameter_invalid
Un parametro ha un valore che l'API non accetta. param lo indica.
404resource_missing
Una voce non è in lista, oppure nessuna buyer persona ha questo 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"]
  }'

Risposta200

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