Add leads to a campaign

POST

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

Send a list of lead objects to add to a campaign.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.plusvibe.ai/api/v1/lead/add' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workspace_id": "6724392a2b582b83709e43d7",
    "campaign_id": "678ed62eeac0980768c2292f",
    "skip_if_in_workspace": false,
    "skip_lead_in_active_pause_camp": true,
    "resume_camp_if_completed": false,
    "leads": [
        {
            "email": "lead2@example.com",
            "first_name": "Jane",
            "last_name": "Smith",
            "notes": "This is a lead referred by XYZ",
            "address_line": "123 Main St",
            "city": "San Francisco",
            "country": "USA",
            "country_code": "US",
            "phone_number": "+1234567890",
            "company_name": "Example Corp",
            "company_website": "https://example.com",
            "linkedin_person_url": "https://linkedin.com/in/janesmith",
            "linkedin_company_url": "https://linkedin.com/company/another",
            "custom_variables": {
                "functional_role": "Marketing"
            }
        }
    ],
    "is_overwrite": false
}'

Response Example

200 - Example 1

{
    "status": "success",
    "total_sent": 10,
    "leads_uploaded": 8,
    "duplicate_email_count": 1,
    "already_in_campaign": 0,
    "invalid_email_count": 0,
    "skipped": 1,
    "remaining_in_plan": 490,
    "overflowed_lead_count": 0
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Successful

Body

🟠400Bad Request

🔴500Server Error

Modified at 2025-07-28 13:01:07

Update Campaign

Add leads to a subsequence campaign