1. Lead
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
    • Webhooks - Payload - System Alert
    • Workspace Deep Link Parameter
  • User API Endpoints
    • Workspace
      • Get workspaces
      • Add a new workspace
      • Copy workspace settings
      • Invite a user to a workspace
    • Campaign
      • Create a new campaign
      • Create a new subsequence
      • List all campaigns
      • Get campaign name
      • Get campaign status
      • Get campaign email accounts
      • Get campaign emails
      • Get campaign variation stats
      • Set campaign name
      • Activate campaign
      • Pause campaign
      • Update Campaign
      • Delete or archive a campaign
      • Duplicate campaign
      • Bulk Assign/Remove Tags from Campaigns
    • 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
      • Get lead counts by status
        GET
    • 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 (Per Mailbox)
      • 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 workspace email stats for a date range
      • Move Email Accounts to Another Workspace
      • Get email account stats for a date range (per mailbox)
      • Get Warmup Stats (Workspace-Level)
    • Analytics
      • Get campaign summary
      • Get campaign stats
      • Get workspaces summary
      • Get all campaigns statistics
      • Get workspaces performance
    • Unibox
      • Get email threads (conversations)
      • 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
      • Send to any address
      • 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
      • 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
      • Parent Test (Recurring & One-off)
        • Create a new parent test
        • Update a parent test
        • List all parent tests
        • Get parent test details
        • Delete parent test(s)
        • Duplicate a parent test
      • Get recipient providers
    • Workspace Additional Fields
      • List Additional Fields
      • Create Additional Field
      • Update Additional Field Default Value
      • Delete Additional Field
    • DFY
      • Search Domain Availability
      • List DFY Subscriptions
      • Generate Sender Identities (MS Enterprise)
      • Place a DFY Order
      • Cancel a DFY Subscription
    • Email Account Automation
      • List automation rules
      • Create automation rule
      • Update automation rule
      • Delete automation rule
      • Get automation rule
      • Enable / disable automation rule
      • Duplicate automation rule
      • Get account recovery details
    • Workspace Settings
      • Get Workspace Settings
      • Update Workspace Settings
      • List Lead Labels
      • Add Custom Lead Label
      • Delete Custom Lead Labels
    • Email Verification
      • Queue email verification
      • Get email verification task
      • Stop email verification task
      • Verify a list of emails
      • Get email verification credits
      • Get email list verification results
      • List email verification tasks
    • Schemas
      • ScheduleV2
      • Campaign
      • 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
      • EmailStatsHeader
      • EmailStatsResponse
      • 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. Lead

Update the status of a lead

POST
https://api.plusvibe.ai/api/v1/lead/update/status
Updates the status of a lead in the specified campaign and workspace.
new_status accepts:
COMPLETED – marks the lead as completed (no further emails).
PAUSED – pauses the lead: it is skipped by campaign sending until resumed. Only leads in NOT_CONTACTED or CONTACTED status can be paused; the lead's status is unchanged and it shows under the PAUSED filter.
UNPAUSED – resumes a paused lead from its current step.
REACTIVATED – puts a SKIPPED lead back into the sequence from the step it stopped at (its status becomes NOT_CONTACTED or CONTACTED; a lead that has replied keeps REPLIED). A lead skipped for a missing MX record is re-checked. Leads skipped by a label change, an invalid email format or a failed verification cannot be re-activated this way, and a replied lead in a campaign that stops on reply stays closed.
Pausing or resuming applies to the lead and all of its subsequence copies (one pause state per lead).

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
Successful update of the lead status.
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.plusvibe.ai/api/v1/lead/update/status' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workspace_id": "65099a0dd96fae8ab61130c0",
    "campaign_id": "67838580ef4b6f32e67e7dfc",
    "email": "notcontacted@plusvibe.ai",
    "new_status": "COMPLETED"
}'
Response Response Example
200 - Example 1
{
    "status": "success"
}
Modified at 2026-10-20 10:18:23
Previous
Fetch workspace leads
Next
Get lead counts by status
Built with