Create a new 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"]
}]
}

**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"
}]
}

**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"
}]
}

**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"
}]
}

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" ] } ] }'

Request

Header Params

x-api-key

string

optional

Your PlusVibe.ai account's API Key

Default:

Example:

your-api-key

Body Params application/json

workspace_id

string

required

The workspace ID under which the subsequence is created.

Example:

65099a0dd96fae8ab61130c0

name

string

required

The name of the subsequence.

Example:

New Subsequence Name

parent_camp_id

string

required

The parent campaign ID to which this subsequence belongs.

Example:

67ee00f7612525c35a6e8abf

events

array [object {2}]

required

An array of event definitions that determine when leads are added. Each event object must specify one of the supported event types and include the required fields for that type.

name

string

required

The event type. Must be one of the following: - LEAD_LABEL_UPDATED - LEAD_REPLY_CONTENT - LEAD_REPLY_ALL - LEAD_REPLY_ALL_EXCEPT_OOO_AUTOMATIC_REPLY

Example:

LEAD_LABEL_UPDATED

val

array[string]

optional

Examples

Responses

🟢200OK

application/json

Campaign subsequence successfully created.

Body

status

string

optional

Indicates the status of the API call.

Example:

success

string

optional

The unique ID of the newly created campaign subsequence.

Example:

67ee01f9a4c4e2b75518d1b8

🟠400Bad Request

🔴500Server Error