PlusVibe.ai
  1. Lead
PlusVibe.ai
  • PlusVibe.ai API Documentation
  • Workspace
    • Get workspaces
      GET
    • Add a new workspace
      POST
  • Campaign
    • Create a new campaign
      POST
    • Create a new subsequence
      POST
    • List campaigns (deprecated)
      GET
    • List all campaigns
      GET
    • Get campaign name
      GET
    • Get campaign status
      GET
    • Get campaign email accounts
      GET
    • Get campaign emails
      GET
    • Set campaign name
      POST
    • Set campaign Schedules
      POST
    • Activate campaign
      POST
    • Pause campaign
      POST
  • Lead
    • Add leads to a campaign
      POST
    • Add leads to a subsequence campaign
      POST
    • Get or search for lead
      GET
    • Delete leads from a campaign
      POST
    • Lead Variable/Label Update or Add
      POST
    • Fetch workspace leads
      GET
    • Update the status of a lead
      POST
  • Email Account
    • List all email accounts in the workspace
      GET
    • Get email account status
      GET
    • Check account vitals
      POST
    • Enable Email account warmup
      POST
    • Pause Email account warmup
      POST
    • Delete Email account
      POST
    • Get Warmup Stats (Individual Account)
      GET
    • Get Warmup Stats (Workspace-Level)
      GET
    • Bulk Add SMTP Accounts
      POST
  • Analytics
    • Get campaign summary
    • Get campaign count (deprecated)
    • Get campaign stats
    • Get all campaigns statistics
  • Unibox
    • Get emails
    • Get count of unread emails
    • Reply to an email
    • Forward an existing email
    • Mark email read
  • Blocklist
    • Get entries in the blocklist
    • Adds entries to the blocklist
    • Delete entries in the blocklist
  • Webhook
    • PlusVibe Webhook Overview
    • Sample Payload - FIRST_EMAIL_REPLIES, ALL_EMAIL_REPLIES, ALL_POSITIVE_REPLIES
    • Sample Payload - LEAD_MARKED_AS_INTERESTED
    • Sample Payload - EMAIL_SENT
    • Add a new webhook
    • List webhooks
    • Delete webhook(s)
  • Tag
    • List Tags
  • For Email Infra Provider Partner
    • List workspaces
    • Initiate Google OAuth login flow
    • Initiate Microsoft OAuth login flow
    • Bulk Add SMTP Accounts (via Username and Password)
  1. Lead

Add leads to a campaign

POST
https://api.plusvibe.ai/api/v1/lead/add
Lead
Send a list of lead objects to add to a campaign.
Request 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,
    "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 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
x-api-key
string 
required
Your PlusVibe.ai account's API Key
Default:
Example:
your-api-key
Body Params application/json
workspace_id
string 
required
campaign_id
string 
required
skip_if_in_workspace
boolean 
optional
When set to True, lead already existed in the workspace would be skipped.
resume_camp_if_completed
boolean 
optional
When set to True, a completed campaign will be resumed to active.
leads
array [object {14}] 
required
email
string 
optional
first_name
string 
optional
last_name
string 
optional
notes
string 
optional
address_line
string 
optional
city
string 
optional
country
string 
optional
country_code
string 
optional
phone_number
string 
optional
company_name
string 
optional
company_website
string 
optional
linkedin_person_url
string 
optional
linkedin_company_url
string 
optional
custom_variables
object 
optional
Custom variables or workspace's additional fields should be put inside this json object
is_overwrite
boolean 
optional
(Optional) If true, existing lead will be updated with the provided fields while retaining any unspecified fields.
Examples

Responses

🟢200OK
application/json
Successful
Body
status
string 
optional
Example:
success
total_sent
integer <int32>
optional
Example:
10
leads_uploaded
integer <int32>
optional
Example:
8
duplicate_email_count
integer <int32>
optional
Example:
1
already_in_campaign
integer <int32>
optional
invalid_email_count
integer <int32>
optional
skipped
integer <int32>
optional
Example:
1
remaining_in_plan
integer <int32>
optional
Example:
490
overflowed_lead_count
integer <int32>
optional
🟠400Bad Request
🔴500Server Error
Modified at 2025-05-31 06:52:23
Previous
Pause campaign
Next
Add leads to a subsequence campaign
Built with