1. Campaign
Plusvibe.ai API Documentation
  • Getting Started
    • Getting Started
    • Webhooks - Overview
    • Webhooks - Payload - Email Replies
    • Webhooks - Payload - Lead Marked As Label
    • Webhooks - Payload - Campaign Emails Sent
    • Webhooks - Payload - Bounced Email
    • Webhooks - Payload - Unibox Email Sent
    • Workspace Deep Link Parameter
    • Email Infra Provider Guide
  • User API Endpoints
    • Workspace
      • Get workspaces
      • Add a new workspace
      • Copy workspace settings
    • 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
      • Get campaign variation stats
        GET
      • Set campaign name
        POST
      • Set campaign Schedules (deprecated)
        POST
      • Activate campaign
        POST
      • Pause campaign
        POST
      • Update Campaign
        PATCH
      • Delete or archive a campaign
        DELETE
    • Lead
      • Add leads to a campaign
      • Add leads to a subsequence campaign
      • Get or search for lead
      • Delete leads from a campaign
      • Lead Variable/Label Update or Add
      • Fetch workspace leads
      • Update the status of a lead
      • Get lead counts by status
    • 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 (Workspace-Level)
      • Bulk Add SMTP Accounts
      • Bulk Update Email Accounts
      • Bulk Update Email Account Warmup Status
      • Bulk Assign/Remove Tags from Email Accounts
      • Bulk reconnect email accounts
      • Get email account stats for a date range
    • Analytics
      • Get campaign summary
      • Get campaign count (deprecated)
      • Get campaign stats
      • Get all campaigns statistics
    • Unibox
      • Get emails
      • Get emails in Others folder
      • Get count of unread emails
      • Reply to an email
      • Forward an existing email
      • Compose New Email
      • Mark Email Read
      • Save Email as Draft
      • Delete an Entire Email Thread
      • Delete a Single Email Message
    • Blocklist
      • Get entries in the blocklist
      • Adds entries to the blocklist
      • Delete entries in the blocklist
    • Webhook
      • Add a new webhook
      • List webhooks
      • Delete webhook(s)
    • Tags
      • List Tags
      • Create a New Tag
      • Update an Existing Tag
      • Delete Multiple Tags
    • Client Access
      • Create client
      • Edit client
      • Update client status
      • Delete client
      • List clients
    • Email Placement Test
      • Parent Recurring Test
        • Create a new parent test (recurring test)
        • Update a parent test
        • List all parent tests
        • Get parent test details
        • Delete parent test(s)
        • Duplicate a parent test
      • Child (Test Run) Test
        • List child (Test Run) tests
        • Get child test details
      • Results & Analytics
        • Get test summary
        • Get detailed test statistics
        • Get test result for a sender account
      • Get recipient providers
    • Schemas
      • ScheduleV2
      • SequenceStep
      • Campaign
      • Variation
      • EmailAccountId
      • WarmupStatus
      • BulkUpdateWarmupRequest
      • TagAction
      • BulkTagAssignmentRequest
      • ObjectId
      • HexColor
      • CreateTagRequest
      • UpdateTagRequest
      • DeleteTagsRequest
      • DeleteCampaignRequest
      • BulkReconnectRequest
      • SuccessResponse
      • ErrorResponse
      • ClientWorkspacePermission
      • CreateClientRequest
      • CreateClientResponse
      • UpdateClientRequest
      • ClientListItem
      • PatchClientStatusRequest
      • GenericSuccessResponse
      • ParentTest
      • ParentTestDetail
      • ChildTest
      • ChildTestDetail
      • VariationStepStats
      • VariationStats
      • CopyWorkspaceRequest
      • ResourceType
      • CopyWorkspaceResponse
      • EmailStatsResponse
      • EmailStatsHeader
      • EmailStatsChartPoint
      • ValidationErrorResponse
      • CheckSuccess
      • AuthFailure
  • For Email Infra Provider
    • Email Infra Provider Guide
    • List workspaces
    • List all email accounts in the workspace
    • Check if an email exists in another workspace
    • Initiate Google OAuth login flow
    • Initiate Microsoft OAuth login flow
    • Bulk Add SMTP Accounts (via Username and Password)
    • Schemas
      • AuthFailure
      • CheckSuccess
      • ErrorResponse
  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

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Body Params application/json

Examples

Responses

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

🟠400Bad Request
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.plusvibe.ai/api/v1/campaign/add/subsequence' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "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"
}
Modified at 2026-07-24 16:34:04
Previous
Create a new campaign
Next
List campaigns (deprecated)
Built with