API reference
Exclusion list
The exclusion list holds the people Gemlead never contacts, by X account or by domain, like your customers, your team or a competitor. A lead on it never enters a campaign. The list holds 5 000 entries.
Each persona has its own list too, set with persona. It holds on every X account that shares the persona. A lead is left out when it is on its persona's list or on its X account's.
The exclusion list object
The X accounts and the domains Gemlead never contacts, like your customers, your team or a competitor. A lead on the list, by its username or the domain on its profile, never enters a campaign.
Attributes
- objectstringAlways
exclusion_list. - persona_idstring or nullThe persona whose own list this is, or null for the X account's list.
- handlesarray of stringsX usernames, without the @.
- domainsarray of stringsDomains, like
bigcustomer.com. An email adds its domain. - max_entriesintegerHow many entries the list holds at most.
{
"object": "exclusion_list",
"persona_id": null,
"handles": ["competitor_hq", "my_cofounder"],
"domains": ["bigcustomer.com"],
"max_entries": 5000
}Retrieve the exclusion list
Returns every X account and domain on the list.
Query parameters
- personastringA persona's ID, to work on that persona's own list. Without it, the X account's list.
Returns
Errors
- No persona with this ID on the key's account.
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
}Add to the exclusion list
Adds X accounts or domains to the list. Leads that match stop in every campaign.
Body parameters
- entriesarray of stringsRequired1 to 500 entries. Each an @username, an x.com profile URL, a domain, or an email for its domain.
- personastringA persona's ID, to work on that persona's own list. Without it, the X account's list.
Returns
The updated exclusion list object.
Errors
- A required parameter is missing.
paramnames it. - A parameter has a value the API does not accept.
paramnames it. - No persona with this ID on the key's account.
- The list would hold more than 5 000 entries.
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
}Remove from the exclusion list
Takes X accounts or domains off the list.
Body parameters
- entriesarray of stringsRequired1 to 500 entries, as listed.
- personastringA persona's ID, to work on that persona's own list. Without it, the X account's list.
Returns
The updated exclusion list object.
Errors
- A required parameter is missing.
paramnames it. - A parameter has a value the API does not accept.
paramnames it. - An entry is not on the list, or no persona with this 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
}