Lead Variable/Label Update or Add

POST

https://api.plusvibe.ai/api/v1/lead/data/update

Lead

When using this endpoint, existing variables/label in the lead's data will be updated, and new variables provided in the variables property will be added to the lead's data.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.plusvibe.ai/api/v1/lead/data/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workspace_id": "65f3c92d3dbe5dbb35374a9a",
    "campaign_id": "66b447598f6dd99f7f7b5c0a",
    "email": "lead@example.com",
    "variables": {
        "label": "NOT_INTERESTED",
        "first_name": "New First Name",
        "language": "Javascript",
        "interest": "Coding"
    }
}'

Response Example

200 - Example 1

{
    "status": "success"
}

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

Workspace ID

Example:

65f3c92d3dbe5dbb35374a9a

campaign_id

string

required

The campaign ID of the lead to be updated

Example:

66b447598f6dd99f7f7b5c0a

string <email>

required

The email of the lead to be updated

Example:

lead@example.com

variables

object

required

A key-value pair object containing the custom variables to be updated. Existing variables will be updated, and new variables will be added.

label

string

optional

The label of the lead to be updated

Example:

NOT_INTERESTED

first_name

string

optional

Example:

New First Name

language

string

optional

Example:

Javascript

interest

string

optional

Example:

Coding

Examples

Responses

🟢200OK

application/json

Successful

Body

status

string

optional

Example:

success

🟠400Bad Request

🔴500Server Error

Modified at 2025-05-24 05:40:10

Delete leads from a campaign

Fetch workspace leads