1. Getting Started
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
    • URL Deep Linking
  • 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
      • 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
      • 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)
      • Bulk Delete Email Accounts
    • 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
      • Cancel a scheduled reply
      • 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
      POST
    • List all email accounts in the workspace
      GET
    • Check if an email exists in another workspace
      GET
    • Initiate Google OAuth login flow
      POST
    • Initiate Microsoft OAuth login flow
      POST
    • Bulk Add SMTP Accounts (via Username and Password)
      POST
    • Schemas
      • AuthFailure
      • CheckSuccess
      • ErrorResponse
  1. Getting Started

URL Deep Linking

PlusVibe supports a few URL query parameters that let external systems open a specific workspace, or a specific inbox thread, when a page loads.
This makes it easier to build direct links from external tools such as CRMs, dashboards, or internal automation.

Open a specific workspace#

If a workspace_id parameter is included in the URL, PlusVibe will automatically switch the user to that workspace when the page loads.

Example#

https://app.plusvibe.ai/v2/campaigns/?workspace_id=66c5860c0d3839cfdfe96e31

When the page opens#

1.
The system detects the workspace_id parameter.
2.
The workspace context is switched automatically.
3.
The page loads using that workspace's data.
The workspace_id value is the same one used by the API (for example GET /analytics/workspaces/summary) and included in webhook payloads.
The user must be a member of that workspace. If they are not, the page keeps the user's current workspace.

Open a specific inbox thread#

To open a thread in the Unibox, add the mail parameter with the thread id. Combine it with workspace_id so the correct workspace is selected first.

Example#

https://app.plusvibe.ai/v2/unibox/inbox/?mail=684baeaab28c872fd921be66&workspace_id=66c5860c0d3839cfdfe96e31

Where to get the thread id#

The mail value is the thread_id returned by the Unibox API (for example GET /unibox/threads) and included in the Email Replies webhook payload.

Folders#

The folder in the path should match where the thread lives. Replace inbox in the URL with the folder name.
inbox - threads with a reply from the lead (most common)
outbox - threads where only your side has sent an email
untracked - replies from addresses that are not campaign leads
scheduled-reply - threads with a reply scheduled to send later
reminder - threads with a reminder set
stared - starred threads
archive - archived threads
draft - threads with a saved draft

Examples#

A thread with a lead reply:
https://app.plusvibe.ai/v2/unibox/inbox/?mail=684baeaab28c872fd921be66&workspace_id=66c5860c0d3839cfdfe96e31
A thread you sent that has no reply yet:
https://app.plusvibe.ai/v2/unibox/outbox/?mail=684baeaab28c872fd921be66&workspace_id=66c5860c0d3839cfdfe96e31
An archived thread:
https://app.plusvibe.ai/v2/unibox/archive/?mail=684baeaab28c872fd921be66&workspace_id=66c5860c0d3839cfdfe96e31
Modified at 2026-11-02 07:47:50
Previous
Webhooks - Payload - System Alert
Next
Get workspaces
Built with