Справочник API

Список исключений

В списке исключений хранятся люди, которым Gemlead никогда не пишет, по аккаунту X или по домену, например ваши клиенты, ваша команда или конкурент. Лид из этого списка никогда не попадает в кампанию. В списке до 5 000 записей.

У каждой персоны есть и свой список, его выбирают через persona. Он действует во всех аккаунтах X, которым открыта персона. Лид исключается, если он есть в списке своей персоны или своего аккаунта X.

Эндпоинты

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

Объект списка исключений

Аккаунты X и домены, которым Gemlead никогда не пишет, например ваши клиенты, ваша команда или конкурент. Лид из списка, по имени пользователя или по домену в профиле, никогда не попадает в кампанию.

Атрибуты

objectstring
Всегда exclusion_list.
persona_idstring или null
Персона, которой принадлежит этот список, или null для списка аккаунта X.
handlesмассив strings
Имена пользователей в X, без @.
domainsмассив strings
Домены, например bigcustomer.com. Для email добавляется его домен.
max_entriesinteger
Максимальное число записей в списке.

Объект списка исключений

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

Получение списка исключений

GET/v1/exclusion_listПраво readMCPget_exclusion_list

Возвращает все аккаунты X и домены из списка.

Параметры запроса

personastring
ID персоны, чтобы работать с собственным списком этой персоны. Без него список аккаунта X.

Возвращает

Объект списка исключений.

Ошибки

404resource_missing
В аккаунте ключа нет персоны с этим ID.

GET/v1/exclusion_list

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

Ответ200

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

Добавление в список исключений

POST/v1/exclusion_list/addПраво writeMCPedit_exclusion_list

Добавляет в список аккаунты X или домены. Подходящие лиды останавливаются во всех кампаниях.

Параметры тела

entriesмассив stringsОбязательно
От 1 до 500 записей. Каждая в виде @username, URL профиля на x.com, домена или email, из которого берётся домен.
personastring
ID персоны, чтобы работать с собственным списком этой персоны. Без него список аккаунта X.

Возвращает

Обновлённый объект списка исключений.

Ошибки

400parameter_missing
Отсутствует обязательный параметр. Название параметра указано в param.
400parameter_invalid
API не принимает значение параметра. Название параметра указано в param.
404resource_missing
В аккаунте ключа нет персоны с этим ID.
400limit_reached
В списке стало бы больше 5 000 записей.

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

Ответ200

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

Удаление из списка исключений

POST/v1/exclusion_list/removeПраво writeMCPedit_exclusion_list

Убирает из списка аккаунты X или домены.

Параметры тела

entriesмассив stringsОбязательно
От 1 до 500 записей, в том виде, в каком они указаны в списке.
personastring
ID персоны, чтобы работать с собственным списком этой персоны. Без него список аккаунта X.

Возвращает

Обновлённый объект списка исключений.

Ошибки

400parameter_missing
Отсутствует обязательный параметр. Название параметра указано в param.
400parameter_invalid
API не принимает значение параметра. Название параметра указано в param.
404resource_missing
Одной из записей нет в списке или нет персоны с этим 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"]
  }'

Ответ200

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