PlusVibe.ai
  1. Campaign
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
    • Update Campaign
      PATCH
  • 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
    • Sample Payload - BOUNCED_EMAIL
    • 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. Campaign

Create a new subsequence

POST
https://api.plusvibe.ai/api/v1/campaign/add/subsequence
Creates a new subsequence under a specified parent campaign. The request payload must include the subsequence name, parent campaign ID, and an array of event objects.
Supported Event Types and Instructions:
1. **LEAD_LABEL_UPDATED**
**Purpose:** Adds leads based on lead labels.
**Instruction:**
Provide an array of lead labels in the `val` field.
**Important:** Each label **must** begin with `LEAD_MARKED_AS_`.
**Exact Example:**
{
"workspace_id": "65099a0dd96fae8ab61130c0",
"name": "API Sub Camp Name",
"parent_camp_id": "67ee00f7612525c35a6e8abf",
"events": [{
"name": "LEAD_LABEL_UPDATED",
"val": ["LEAD_MARKED_AS_INTERESTED", "LEAD_MARKED_AS_MEETING_BOOKED"]
}]
}
2.
**LEAD_REPLY_CONTENT**
**Purpose:** Adds leads when a reply contains (or excludes) specified text.
**Instruction:**
The `include_text` field is required and should specify the text that must appear in the lead's reply; you can also optionally provide `exclude_text` for text that must not be present.
**Exact Example:**
{
"name": "test",
"parent_camp_id": "67edfddba4c4e2b75518d1b7",
"events": [{
"name": "LEAD_REPLY_CONTENT",
"include_text": "call me, CALL ME",
"exclude_text": "not interested, don't call me"
}]
}
3.
**LEAD_REPLY_ALL**
**Purpose:** Adds leads when any reply is received.
**Instruction:**
No additional fields are required beyond specifying the event name.
**Exact Example:**
{
"name": "Test Subsequence with LEAD_REPLY_ALL",
"parent_camp_id": "67ee00f7612525c35a6e8abf",
"events": [{
"name": "LEAD_REPLY_ALL"
}]
}
4.
**LEAD_REPLY_ALL_EXCEPT_OOO_AUTOMATIC_REPLY**
**Purpose:** Adds leads when any reply is received, excluding replies that are Out of Office or Automatic Replies.
**Instruction:**
No additional fields are required beyond specifying the event name.
**Exact Example:**
{
"name": "Test Subsequence with LEAD_REPLY_ALL_EXCEPT_OOO_AUTOMATIC_REPLY",
"parent_camp_id": "67ee00f7612525c35a6e8abf",
"events": [{
"name": "LEAD_REPLY_ALL_EXCEPT_OOO_AUTOMATIC_REPLY"
}]
}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.plusvibe.ai/api/v1/campaign/add/subsequence' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workspace_id": "65099a0dd96fae8ab61130c0",
    "name": "New Subsequence Name",
    "parent_camp_id": "67ee00f7612525c35a6e8abf",
    "events": [
        {
            "name": "LEAD_LABEL_UPDATED",
            "val": [
                "LEAD_MARKED_AS_INTERESTED"
            ]
        }
    ]
}'
Response Response Example
200 - Example 1
{
    "status": "success",
    "id": "67ee01f9a4c4e2b75518d1b8"
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Campaign subsequence successfully created.
Body

🟠400Bad Request
🔴500Server Error
Modified at 2025-05-24 06:50:42
Previous
Create a new campaign
Next
List campaigns (deprecated)
Built with