Delete leads from a campaign

POST

https://api.plusvibe.ai/api/v1/lead/delete

Lead

Users can remove leads by providing the campaign ID and other optional parameters, such as deleting leads with matching domains. The action helps users efficiently manage their campaign's lead database by removing unwanted entries.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.plusvibe.ai/api/v1/lead/delete' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workspace_id": "65f3c92d3dbe5dbb35374a9a",
    "campaign_id": "66b447598f6dd99f7f7b5c0a",
    "delete_all_from_company": true,
    "delete_list": [
        "lead1@example.com"
    ]
}'

Response Example

200 - Example 1

{
    "status": "success"
}

Request

Header Params

x-api-key

string

optional

Your PlusVibe.ai account's API Key

Default:

Example:

your-api-key

Body Params application/json

workspace_id

string

required

Workspace ID

Example:

65f3c92d3dbe5dbb35374a9a

campaign_id

string

optional

Campaign ID

Example:

66b447598f6dd99f7f7b5c0a

delete_all_from_company

boolean

optional

Set to true if you would like to remove all leads with matching domains

Example:

true

delete_list

array[string]

required

A list of email addresses corresponding to the leads you want to delete. Must include at least one email.

Examples

Responses

🟢200OK

application/json

Successful

Body

status

string

optional

Example:

success

🟠400Bad Request

🔴500Server Error

Modified at 2025-05-24 05:40:10

Get or search for lead

Lead Variable/Label Update or Add