Lists
Remove many leads from a list
API Documentation
Status
Workspaces
Leads
- POSTCreate Lead
- GETGet a lead by id
- DELDelete a lead
- PATCHUpdate Lead
- POSTDelete many leads
- PATCHUpdate many leads
- POSTList leads with pagination and filters
- POSTAdd a list to leads
- POSTTrack a lead
- GETGet count of tracked leads
- POSTTrack leads
- POSTConnect a lead to a company
- POSTDisconnect a lead from a company
- POSTSearch leads
Lists
Campaigns
Reminders
Lists
Remove many leads from a list
Remove your leads from a list based on filters
POST
/
lists
/
{id}
/
remove-leads
curl --request POST \
--url https://api.breakcold.com/rest/lists/{id}/remove-leads \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"filter": {
"leads": [
"<string>"
],
"not_leads": [
"<string>"
],
"is_company": true,
"is_tracked": true,
"email_status": "all",
"search": "<string>",
"sequences_steps": {
"id": [
"<string>"
],
"status": [
"is_opened"
]
},
"campaigns": [
"<string>"
],
"has_icebreaker": true,
"tags": [
"<string>"
],
"status": [
"<string>"
],
"has_list": true,
"has_no_list": true,
"lists": [
"<string>"
],
"has_owner": true,
"has_no_owner": true,
"owners": [
"<string>"
],
"score": [
"<string>"
],
"attributes": [
{
"id": "<string>",
"value": "<string>",
"operator": "equals"
}
]
}
}'
"<string>"
Authorizations
Path Parameters
Body
application/json
Available options:
all
, bounce
, not-sure-bounce
, valid
, no-email
Response
200
application/json
Successful response
The response is of type string
.
curl --request POST \
--url https://api.breakcold.com/rest/lists/{id}/remove-leads \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"filter": {
"leads": [
"<string>"
],
"not_leads": [
"<string>"
],
"is_company": true,
"is_tracked": true,
"email_status": "all",
"search": "<string>",
"sequences_steps": {
"id": [
"<string>"
],
"status": [
"is_opened"
]
},
"campaigns": [
"<string>"
],
"has_icebreaker": true,
"tags": [
"<string>"
],
"status": [
"<string>"
],
"has_list": true,
"has_no_list": true,
"lists": [
"<string>"
],
"has_owner": true,
"has_no_owner": true,
"owners": [
"<string>"
],
"score": [
"<string>"
],
"attributes": [
{
"id": "<string>",
"value": "<string>",
"operator": "equals"
}
]
}
}'
"<string>"