Referencia de la API
Lista de exclusión
La lista de exclusión reúne a quienes Gemlead nunca contacta, por cuenta de X o por dominio, como tus clientes, tu equipo o un competidor. Un lead que está en ella nunca entra en una campaña. La lista admite 5 000 entradas.
Cada buyer persona tiene además su propia lista, que se indica con persona. Vale en todas las cuentas de X que comparten el buyer persona. Un lead queda fuera si está en la lista de su buyer persona o en la de su cuenta de X.
El objeto exclusion list
Las cuentas de X y los dominios que Gemlead nunca contacta, como tus clientes, tu equipo o un competidor. Un lead que está en la lista, por su nombre de usuario o por el dominio de su perfil, nunca entra en una campaña.
Atributos
- objectstringSiempre
exclusion_list. - persona_idstring o nullEl buyer persona al que pertenece esta lista, o null para la lista de la cuenta de X.
- handlesarray de stringsNombres de usuario de X, sin la @.
- domainsarray de stringsDominios, como
bigcustomer.com. Un email añade su dominio. - max_entriesintegerCuántas entradas admite la lista como máximo.
{
"object": "exclusion_list",
"persona_id": null,
"handles": ["competitor_hq", "my_cofounder"],
"domains": ["bigcustomer.com"],
"max_entries": 5000
}Obtener la lista de exclusión
Devuelve todas las cuentas de X y todos los dominios de la lista.
Parámetros de consulta
- personastringEl ID de un buyer persona, para trabajar con su propia lista. Sin él, la lista de la cuenta de X.
Devuelve
Errores
- No hay ningún buyer persona con este ID en la cuenta de la clave.
curl https://gemlead.ai/api/v1/exclusion_list \
-H "Authorization: Bearer $GEMLEAD_API_KEY"{
"object": "exclusion_list",
"persona_id": null,
"handles": ["competitor_hq", "my_cofounder"],
"domains": ["bigcustomer.com"],
"max_entries": 5000
}Añadir a la lista de exclusión
Añade cuentas de X o dominios a la lista. Los leads que coinciden se detienen en todas las campañas.
Parámetros del cuerpo
- entriesarray de stringsObligatorioDe 1 a 500 entradas. Cada una es un @usuario, una URL de perfil de x.com, un dominio o un email para su dominio.
- personastringEl ID de un buyer persona, para trabajar con su propia lista. Sin él, la lista de la cuenta de X.
Devuelve
El objeto exclusion list actualizado.
Errores
- Falta un parámetro obligatorio.
paramlo indica. - Un parámetro tiene un valor que la API no acepta.
paramlo indica. - No hay ningún buyer persona con este ID en la cuenta de la clave.
- La lista tendría más de 5 000 entradas.
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"]
}'{
"object": "exclusion_list",
"persona_id": null,
"handles": ["competitor_hq", "my_cofounder"],
"domains": ["bigcustomer.com"],
"max_entries": 5000
}Quitar de la lista de exclusión
Quita cuentas de X o dominios de la lista.
Parámetros del cuerpo
- entriesarray de stringsObligatorioDe 1 a 500 entradas, tal como aparecen en la lista.
- personastringEl ID de un buyer persona, para trabajar con su propia lista. Sin él, la lista de la cuenta de X.
Devuelve
El objeto exclusion list actualizado.
Errores
- Falta un parámetro obligatorio.
paramlo indica. - Un parámetro tiene un valor que la API no acepta.
paramlo indica. - Una entrada no está en la lista, o ningún buyer persona tiene este ID.
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"]
}'{
"object": "exclusion_list",
"persona_id": null,
"handles": ["competitor_hq"],
"domains": ["bigcustomer.com"],
"max_entries": 5000
}