PlusVibe.ai
  1. For Email Infra Provider Partner
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 email account status
    • Check account vitals
    • Enable Email account warmup
    • Pause Email account warmup
    • Delete Email account
    • Get Warmup Stats (Individual Account)
    • Get Warmup Stats (Workspace-Level)
    • Bulk Add SMTP Accounts
  • 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
      POST
    • Initiate Google OAuth login flow
      POST
    • Initiate Microsoft OAuth login flow
      POST
    • Bulk Add SMTP Accounts (via Username and Password)
      POST
  1. For Email Infra Provider Partner

Bulk Add SMTP Accounts (via Username and Password)

POST
https://api.plusvibe.ai/v1/partner-upload-regular-accounts
Account
Bulk add multiple SMTP (non-Google / non-Microsoft) email accounts via API, by providing PlusVibe Username and Password. A notification email can be set to receive the upload results.
*** Note: A successful response does not indicate that the email accounts were added successfully. It only means that the server has accepted the request. The results of the upload will be sent to provided notification email address. ***
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.plusvibe.ai/v1/partner-upload-regular-accounts' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workspace_id": "65099a0dd96fae8ab61120c0",
    "accounts": [
        {
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@domain.com",
            "daily_limit": 20,
            "username": "john.doe@domain.com",
            "password": "password1234!",
            "imap_host": "imap.domain.com",
            "imap_port": 993,
            "smtp_host": "smtp.domain.com",
            "smtp_username": "john.doe@domain.com",
            "smtp_password": "password1234!",
            "smtp_port": 465,
            "min_interval": 6,
            "enable_camp_rampup": "yes",
            "camp_rampup_start": 5,
            "camp_rampup_increment": 2,
            "enable_warmup": "yes",
            "warmup_daily_limit": 25,
            "enable_warmup_rampup": "yes",
            "warmup_rampup_start": 5,
            "warmup_rampup_increment": 3
        }
    ],
    "pipl_username": "string",
    "pipl_password": "string",
    "notification_email": "string"
}'
Response Response Example
{
    "status": "success"
}

Request

Header Params
x-api-key
string 
required
Your PlusVibe.ai account's API Key
Body Params application/json
workspace_id
string 
required
Workspace identifier.
Example:
65099a0dd96fae8ab61120c0
accounts
array [object {21}] 
required
List of accounts to add.
>= 1 items
first_name
string 
required
Example:
John
last_name
string 
required
Example:
Doe
email
string <email>
required
Example:
john.doe@domain.com
daily_limit
integer 
required
Campaign daily limit
Example:
20
username
string 
required
IMAP username
Example:
john.doe@domain.com
password
string 
required
IMAP password
Example:
password1234!
imap_host
string 
required
Example:
imap.domain.com
imap_port
integer 
required
Example:
993
smtp_host
string 
required
Example:
smtp.domain.com
smtp_username
string 
required
Example:
john.doe@domain.com
smtp_password
string 
required
Example:
password1234!
smtp_port
integer 
required
Example:
465
min_interval
integer 
optional
Campaign emails' minimum interval
Example:
6
enable_camp_rampup
enum<string> 
optional
(Optional) Enable campaign ramp-up
Allowed values:
yesno
Example:
yes
camp_rampup_start
integer 
optional
(Optional) Campaign Ramp-up initial value
Example:
5
camp_rampup_increment
integer 
optional
(Optional) Campaign Ramp-up daily increment
Example:
2
enable_warmup
enum<string> 
optional
(Optional) Enable warm-up
Allowed values:
yesno
Example:
yes
warmup_daily_limit
integer 
optional
(Optional) Warmup ramup-up daily limit
Example:
25
enable_warmup_rampup
enum<string> 
optional
(Optional) Enable warmup ramp-up
Allowed values:
yesno
Example:
yes
warmup_rampup_start
integer 
optional
(Optional) Warmup Ramp-up initial value
Example:
5
warmup_rampup_increment
integer 
optional
(Optional) Warmup ramup-up daily increment
Example:
3
pipl_username
string 
required
Login Email
pipl_password
string 
required
Password
notification_email
string 
optional
The email address that you want to receive the upload results
Examples

Responses

🟢200OK
application/json
API called successfully.
Body
status
string 
optional
Example:
success
Modified at 2025-06-06 15:20:22
Previous
Initiate Microsoft OAuth login flow
Built with