Referência da API

Lista de exclusão

A lista de exclusão reúne as pessoas que o Gemlead nunca contata, por conta do X ou por domínio, como seus clientes, sua equipe ou um concorrente. Um lead que está nela nunca entra numa campanha. A lista comporta 5 000 entradas.

Cada persona também tem a própria lista, indicada com persona. Ela vale em toda conta do X que compartilha a persona. Um lead fica de fora quando está na lista da persona dele ou na da conta do X dele.

Endpoints

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

O objeto exclusion list

As contas do X e os domínios que o Gemlead nunca contata, como seus clientes, sua equipe ou um concorrente. Um lead que está na lista, pelo username ou pelo domínio do perfil dele, nunca entra numa campanha.

Atributos

objectstring
Sempre exclusion_list.
persona_idstring ou null
A persona dona desta lista, ou null para a lista da conta do X.
handlesarray de strings
Usernames do X, sem o @.
domainsarray de strings
Domínios, como bigcustomer.com. Um email adiciona o domínio dele.
max_entriesinteger
Quantas entradas a lista comporta no máximo.

O objeto exclusion list

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

Obter a lista de exclusão

GET/v1/exclusion_listScope readMCPget_exclusion_list

Retorna todas as contas do X e todos os domínios da lista.

Parâmetros de consulta

personastring
O ID de uma persona, para trabalhar com a lista própria dessa persona. Sem ele, a lista da conta do X.

Retorno

O objeto exclusion list.

Erros

404resource_missing
Nenhuma persona com este ID na conta da chave.

GET/v1/exclusion_list

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

Resposta200

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

Adicionar à lista de exclusão

POST/v1/exclusion_list/addScope writeMCPedit_exclusion_list

Adiciona contas do X ou domínios à lista. Os leads correspondentes saem de todas as campanhas.

Parâmetros do corpo

entriesarray de stringsObrigatório
De 1 a 500 entradas. Cada uma é um @username, uma URL de perfil do x.com, um domínio ou um email, que vale pelo domínio.
personastring
O ID de uma persona, para trabalhar com a lista própria dessa persona. Sem ele, a lista da conta do X.

Retorno

O objeto exclusion list atualizado.

Erros

400parameter_missing
Falta um parâmetro obrigatório. param diz qual.
400parameter_invalid
Um parâmetro tem um valor que a API não aceita. param diz qual.
404resource_missing
Nenhuma persona com este ID na conta da chave.
400limit_reached
A lista passaria de 5 000 entradas.

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

Resposta200

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

Remover da lista de exclusão

POST/v1/exclusion_list/removeScope writeMCPedit_exclusion_list

Tira contas do X ou domínios da lista.

Parâmetros do corpo

entriesarray de stringsObrigatório
De 1 a 500 entradas, como aparecem na lista.
personastring
O ID de uma persona, para trabalhar com a lista própria dessa persona. Sem ele, a lista da conta do X.

Retorno

O objeto exclusion list atualizado.

Erros

400parameter_missing
Falta um parâmetro obrigatório. param diz qual.
400parameter_invalid
Um parâmetro tem um valor que a API não aceita. param diz qual.
404resource_missing
Uma entrada não está na lista, ou nenhuma persona tem este 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"]
  }'

Resposta200

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