# PlusVibe.ai

## Docs
- [PlusVibe.ai API Documentation](https://developer.plusvibe.ai/plusvibe-ai-api-documentation-1039243m0.md): 
- Webhook [PlusVibe Webhook Overview](https://developer.plusvibe.ai/plusvibe-webhook-overview-1133711m0.md): 
- Webhook [Sample Payload - FIRST_EMAIL_REPLIES, ALL_EMAIL_REPLIES, ALL_POSITIVE_REPLIES](https://developer.plusvibe.ai/sample-payload-first-email-replies-all-email-replies-all-positive-replies-1073090m0.md): 
- Webhook [Sample Payload - LEAD_MARKED_AS_INTERESTED](https://developer.plusvibe.ai/sample-payload-lead-marked-as-interested-1133748m0.md): 
- Webhook [Sample Payload - EMAIL_SENT](https://developer.plusvibe.ai/sample-payload-email-sent-1133774m0.md): 
- Webhook [Sample Payload - BOUNCED_EMAIL](https://developer.plusvibe.ai/sample-payload-bounced-email-1325088m0.md): 
- [For Email Infra Provider Partner](https://developer.plusvibe.ai/for-email-infra-provider-partner-3832651f0.md): 

## API Docs
- Workspace [Get workspaces](https://developer.plusvibe.ai/get-workspaces-17237993e0.md): Test the provided API key and returns the list of accessible workspaces.
- Workspace [Add a new workspace](https://developer.plusvibe.ai/add-a-new-workspace-17237994e0.md): Adds a new workspace to PlusVibe.ai using an existing workspace ID for reference.
- Campaign [Create a new campaign](https://developer.plusvibe.ai/create-a-new-campaign-17237995e0.md): Creates a new campaign under a specified workspace.
- Campaign [Create a new subsequence](https://developer.plusvibe.ai/create-a-new-subsequence-17237996e0.md): 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.
- Campaign [List campaigns (deprecated)](https://developer.plusvibe.ai/list-campaigns-deprecated-17237997e0.md): List of campaigns associated with their workspace
- Campaign [List all campaigns](https://developer.plusvibe.ai/list-all-campaigns-17237998e0.md): Retrieve a list of campaigns for a specific workspace with optional filtering capabilities. Results are sorted by creation date with the newest campaigns first.
- Campaign [Get campaign name](https://developer.plusvibe.ai/get-campaign-name-17237999e0.md): Get campaign name
- Campaign [Get campaign status](https://developer.plusvibe.ai/get-campaign-status-17238000e0.md): Get campaign status
- Campaign [Get campaign email accounts](https://developer.plusvibe.ai/get-campaign-email-accounts-17238001e0.md): Get a list of email accounts associated to the campaign
- Campaign [Get campaign emails](https://developer.plusvibe.ai/get-campaign-emails-17238002e0.md): Fetch campaign emails sent to a specific lead within a workspace. Optional `campaign_id` parameter can filter emails for a specific campaign.
- Campaign [Set campaign name](https://developer.plusvibe.ai/set-campaign-name-17238003e0.md): This section allows users to set a new name for their campaign. By providing the campaign ID and the desired name, users can easily update the name of their campaign.
- Campaign [Set campaign Schedules (deprecated)](https://developer.plusvibe.ai/set-campaign-schedules-deprecated-17238004e0.md): Please use "Update campaign" endpoint to set the schedule
- Campaign [Activate campaign](https://developer.plusvibe.ai/activate-campaign-17238005e0.md): This endpoint will activate a campaign
- Campaign [Pause campaign](https://developer.plusvibe.ai/pause-campaign-17238006e0.md): Pause campaign
- Campaign [Update Campaign](https://developer.plusvibe.ai/update-campaign-19620373e0.md): This is a PATCH endpoint to update an existing campaign.
- Campaign [Delete or archive a campaign](https://developer.plusvibe.ai/delete-or-archive-a-campaign-21411384e0.md): Deletes or archives a campaign based on the provided parameters. 
- Lead [Add leads to a campaign](https://developer.plusvibe.ai/add-leads-to-a-campaign-17238007e0.md): Send a list of lead objects to add to a campaign.
- Lead [Add leads to a subsequence campaign](https://developer.plusvibe.ai/add-leads-to-a-subsequence-campaign-17238008e0.md): Add existing leads from a parent campaign to a subsequence campaign. This allows you to move leads that have completed one campaign sequence into a follow-up sequence.
- Lead [Get or search for lead](https://developer.plusvibe.ai/get-or-search-for-lead-17238009e0.md): This endpoint can also be used to search for a lead - if campaign\_id is left blank, all leads matching email will be returned.
- Lead [Delete leads from a campaign](https://developer.plusvibe.ai/delete-leads-from-a-campaign-17238010e0.md): Users can remove leads by providing the campaign ID and other optional parameters, such as deleting leads with matching domains. The action helps users efficiently manage their campaign's lead database by removing unwanted entries.
- Lead [Lead Variable/Label Update or Add](https://developer.plusvibe.ai/lead-variablelabel-update-or-add-17238011e0.md): 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.
- Lead [Fetch workspace leads](https://developer.plusvibe.ai/fetch-workspace-leads-17238012e0.md): Retrieve a list of leads based on specified filters like status, campaign, and more.
- Lead [Update the status of a lead](https://developer.plusvibe.ai/update-the-status-of-a-lead-17238013e0.md): Updates the status of a lead in the specified campaign and workspace. Only `new_status` set to `COMPLETED` is accepted.
- Lead [Get lead counts by status](https://developer.plusvibe.ai/get-lead-counts-by-status-21402115e0.md): Retrieve the number of leads for each status in a workspace. Optionally filter by campaign.
- Email Account [List all email accounts in the workspace](https://developer.plusvibe.ai/list-all-email-accounts-in-the-workspace-17238014e0.md): List all email accounts in the workspace. Can be filtered by tags or single email.
- Email Account [Get email account status](https://developer.plusvibe.ai/get-email-account-status-17238015e0.md): Get Email account status and warmup status for the passed email account
- Email Account [Check account vitals](https://developer.plusvibe.ai/check-account-vitals-17238016e0.md): This endpoint allows you to quickly check if the SPF, DKIM, and DMARC records have been properly set for a list of domains.
- Email Account [Enable Email account warmup](https://developer.plusvibe.ai/enable-email-account-warmup-17238017e0.md): Enable Email account warmup
- Email Account [Pause Email account warmup](https://developer.plusvibe.ai/pause-email-account-warmup-17238018e0.md): Pause Email account warmup
- Email Account [Delete Email account](https://developer.plusvibe.ai/delete-email-account-17238019e0.md): Delete Email account
- Email Account [Get Warmup Stats (Individual Account)](https://developer.plusvibe.ai/get-warmup-stats-individual-account-17238492e0.md): Returns warmup metrics (inbox, spam, promotion) for a specified email account over a given date range.
- Email Account [Get Warmup Stats (Workspace-Level)](https://developer.plusvibe.ai/get-warmup-stats-workspace-level-17238020e0.md): Returns warmup metrics (inbox, spam, promotion) for **all** email accounts in a workspace over a given date range if `email_acc_id` is not provided.
- Email Account [Bulk Add SMTP Accounts](https://developer.plusvibe.ai/bulk-add-smtp-accounts-17737937e0.md): Bulk add multiple SMTP (non-Google / non-Microsoft) email accounts via API.
- Email Account [Bulk Update Email Accounts](https://developer.plusvibe.ai/bulk-update-email-accounts-21391027e0.md): This endpoint allows you to modify various settings for multiple email accounts simultaneously, including basic information, daily limits, signatures, warmup settings, and rampup configurations. Only provided fields will be updated; omitted fields remain unchanged.
- Email Account [Bulk Update Email Account Warmup Status](https://developer.plusvibe.ai/bulk-update-email-account-warmup-status-21393152e0.md): This endpoint allows you to modify the warmup status for multiple email accounts simultaneously.
- Email Account [Bulk Assign/Remove Tags from Email Accounts](https://developer.plusvibe.ai/bulk-assignremove-tags-from-email-accounts-21396110e0.md): description: |
- Email Account [Bulk reconnect email accounts](https://developer.plusvibe.ai/bulk-reconnect-email-accounts-21411385e0.md): Reconnecting only works if account credentials haven't changed (e.g., a temporary error or bounce).
- Analytics [Get campaign summary](https://developer.plusvibe.ai/get-campaign-summary-17238021e0.md): Get campaign summary
- Analytics [Get campaign count (deprecated)](https://developer.plusvibe.ai/get-campaign-count-deprecated-17238022e0.md): Get the actual data count for a campaign (This endpoint is replaced by “Get campaign stats”)
- Analytics [Get campaign stats](https://developer.plusvibe.ai/get-campaign-stats-17238023e0.md): Retrieve detailed statistics for a specific campaign or all campaigns within a workspace. Users can track metrics such as lead count, completion status, contact interactions, and more to gain insights into campaign performance and engagement levels. This section provides valuable data for analyzing and optimizing marketing strategies.
- Analytics [Get all campaigns statistics](https://developer.plusvibe.ai/get-all-campaigns-statistics-17238024e0.md): Retrieves aggregated statistics across all campaigns within a workspace for a given date range.
- Unibox [Get emails](https://developer.plusvibe.ai/get-emails-17238025e0.md): Get emails
- Unibox [Get emails in Others folder](https://developer.plusvibe.ai/get-emails-in-others-folder-26664106e0.md): This folder shows replies not related to campaigns and leads. Replies here will be kept for 2 weeks.
- Unibox [Get count of unread emails](https://developer.plusvibe.ai/get-count-of-unread-emails-17238026e0.md): Returns the count of unread emails for a given workspace
- Unibox [Reply to an email](https://developer.plusvibe.ai/reply-to-an-email-17238027e0.md): Sends a reply to an existing email
- Unibox [Forward an existing email](https://developer.plusvibe.ai/forward-an-existing-email-17238028e0.md): Forwards an email to a new recipient. The body will appear above the original message content.
- Unibox [Compose New Email ](https://developer.plusvibe.ai/compose-new-email-21409197e0.md): This endpoint allows you to compose a new email to any lead
- Unibox [Mark Email Read](https://developer.plusvibe.ai/mark-email-read-17238029e0.md): Mark all unread emails as read, in the thread
- Unibox [Save Email as Draft](https://developer.plusvibe.ai/save-email-as-draft-25824244e0.md): Saves an email message as a draft in the Unibox for the specified workspace. The draft can later be edited or sent by the user. No email is delivered to recipients when using this endpoint.
- Unibox [Delete an Entire Email Thread](https://developer.plusvibe.ai/delete-an-entire-email-thread-25985491e0.md): Deletes an entire Unibox email thread, including all messages within the thread.
- Unibox [Delete a Single Email Message](https://developer.plusvibe.ai/delete-a-single-email-message-25985492e0.md): Deletes a single email message within an existing Unibox thread.
- Blocklist [Get entries in the blocklist](https://developer.plusvibe.ai/get-entries-in-the-blocklist-17238030e0.md): Retrieve a list of blocklisted values for the specified workspace.
- Blocklist [Adds entries to the blocklist](https://developer.plusvibe.ai/adds-entries-to-the-blocklist-17238031e0.md): Adds email addresses or domains to the blocklist
- Blocklist [Delete entries in the blocklist](https://developer.plusvibe.ai/delete-entries-in-the-blocklist-17238032e0.md): Delete entries in the blocklist
- Webhook [Add a new webhook](https://developer.plusvibe.ai/add-a-new-webhook-17238033e0.md): Add a webhook to PlusVibe.ai for specified events, campaigns, and conditions.
- Webhook [List webhooks](https://developer.plusvibe.ai/list-webhooks-17238034e0.md): Retrieves a list of all webhooks for the specified workspace. The `workspace_id` must be provided as a query parameter.
- Webhook [Delete webhook(s)](https://developer.plusvibe.ai/delete-webhooks-17238035e0.md): Deletes one or more webhooks by their IDs, within the specified workspace. Provide the `workspace_id` and an array of webhook IDs to delete in the JSON body.
- Tags [List Tags](https://developer.plusvibe.ai/list-tags-17238036e0.md): Retrieves a list of tags associated with a workspace.
- Tags [Create a New Tag](https://developer.plusvibe.ai/create-a-new-tag-21404673e0.md): Creates a new tag in the specified workspace. Tags are used to organize and categorize email accounts and campaigns.
- Tags [Update an Existing Tag](https://developer.plusvibe.ai/update-an-existing-tag-21404674e0.md): Updates an existing tag's properties including name, color, and description.
- Tags [Delete Multiple Tags](https://developer.plusvibe.ai/delete-multiple-tags-21404675e0.md): Deletes one or more tags from the workspace. This operation also removes the tags from all associated email accounts and campaigns.
- Client Access [Create client](https://developer.plusvibe.ai/create-client-24563838e0.md): Create a client and assign them to one or more workspaces.
- Client Access [Edit client](https://developer.plusvibe.ai/edit-client-24563839e0.md): Update client info and workspace permissions.
- Client Access [Update client status](https://developer.plusvibe.ai/update-client-status-24563840e0.md): Activate or deactivate a client.
- Client Access [List clients](https://developer.plusvibe.ai/list-clients-24563842e0.md): Fetch all clients in a workspace.
- Client Access [Delete client](https://developer.plusvibe.ai/delete-client-24563841e0.md): Permanently remove a client from the workspace.
- For Email Infra Provider Partner [List workspaces](https://developer.plusvibe.ai/list-workspaces-17238037e0.md): These endpoints allow email infrastructure provider partners to programmatically initiate the Google/Microsoft OAuth login flow to add an account to PlusVibe.
- For Email Infra Provider Partner [List all email accounts in the workspace](https://developer.plusvibe.ai/list-all-email-accounts-in-the-workspace-25729696e0.md): List all email accounts in the workspace. Can be filtered by tags or single email.
- For Email Infra Provider Partner [Initiate Google OAuth login flow](https://developer.plusvibe.ai/initiate-google-oauth-login-flow-17238038e0.md): These endpoints allow email infrastructure provider partners to programmatically initiate the Google/Microsoft OAuth login flow to add an account to PlusVibe.
- For Email Infra Provider Partner [Initiate Microsoft OAuth login flow](https://developer.plusvibe.ai/initiate-microsoft-oauth-login-flow-17238039e0.md): These endpoints allow email infrastructure provider partners to programmatically initiate the Google/Microsoft OAuth login flow to add an account to PlusVibe.
- For Email Infra Provider Partner [Bulk Add SMTP Accounts (via Username and Password)](https://developer.plusvibe.ai/bulk-add-smtp-accounts-via-username-and-password-17738297e0.md): Bulk add multiple SMTP (non-Google / non-Microsoft) email accounts via API, by providing PlusVibe Username and Password. A notification email can be set to receive the upload results.

## Schemas
- Schemas [ScheduleV2](https://developer.plusvibe.ai/schedulev2-8331221d0.md): 
- Schemas [EmailAccountId](https://developer.plusvibe.ai/emailaccountid-9396504d0.md): 
- Schemas [DeleteCampaignRequest](https://developer.plusvibe.ai/deletecampaignrequest-9404586d0.md): 
- Schemas [ObjectId](https://developer.plusvibe.ai/objectid-9400809d0.md): 
- Schemas [SequenceStep](https://developer.plusvibe.ai/sequencestep-8331222d0.md): 
- Schemas [BulkReconnectRequest](https://developer.plusvibe.ai/bulkreconnectrequest-9404587d0.md): 
- Schemas [HexColor](https://developer.plusvibe.ai/hexcolor-9400810d0.md): 
- Schemas [TagAction](https://developer.plusvibe.ai/tagaction-9396890d0.md): 
- Schemas [WarmupStatus](https://developer.plusvibe.ai/warmupstatus-9396505d0.md): 
- Schemas [BulkTagAssignmentRequest](https://developer.plusvibe.ai/bulktagassignmentrequest-9396891d0.md): 
- Schemas [CreateTagRequest](https://developer.plusvibe.ai/createtagrequest-9400811d0.md): 
- Schemas [BulkUpdateWarmupRequest](https://developer.plusvibe.ai/bulkupdatewarmuprequest-9396506d0.md): 
- Schemas [Variation](https://developer.plusvibe.ai/variation-8331271d0.md): 
- Schemas [Campaign](https://developer.plusvibe.ai/campaign-8331223d0.md): 
- Schemas [SuccessResponse](https://developer.plusvibe.ai/successresponse-9396507d0.md): 
- Schemas [UpdateTagRequest](https://developer.plusvibe.ai/updatetagrequest-9400812d0.md): 
- Schemas [ErrorResponse](https://developer.plusvibe.ai/errorresponse-9396508d0.md): 
- Schemas [DeleteTagsRequest](https://developer.plusvibe.ai/deletetagsrequest-9400813d0.md): 
- [ClientWorkspacePermission](https://developer.plusvibe.ai/clientworkspacepermission-11090137d0.md): 
- [CreateClientRequest](https://developer.plusvibe.ai/createclientrequest-11090138d0.md): 
- [CreateClientResponse](https://developer.plusvibe.ai/createclientresponse-11090139d0.md): 
- [UpdateClientRequest](https://developer.plusvibe.ai/updateclientrequest-11090140d0.md): 
- [ClientListItem](https://developer.plusvibe.ai/clientlistitem-11090141d0.md): 
- [PatchClientStatusRequest](https://developer.plusvibe.ai/patchclientstatusrequest-11090142d0.md): 
- [GenericSuccessResponse](https://developer.plusvibe.ai/genericsuccessresponse-11090143d0.md):