Copy Page
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
Create a new subsequence
List campaigns (deprecated)
List all campaigns
Get campaign name
Get campaign status
Get campaign email accounts
Get campaign emails
Get campaign variation stats
Set campaign name
Set campaign Schedules (deprecated)
Activate campaign
Pause campaign
Update Campaign
Delete or archive a campaign
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
ErrorResponse
Copy Page
{
"code"
:
0
,
"message"
:
"string"
,
"data"
:
{
}
}