PlusVibe.ai
    PlusVibe.ai
    • PlusVibe.ai API Documentation
    • Workspace
      • Get workspaces
        GET
      • Add a new workspace
        POST
    • Campaign
      • Create a new campaign
        POST
      • Create a new subsequence
        POST
      • List campaigns (deprecated)
        GET
      • List all campaigns
        GET
      • Get campaign name
        GET
      • Get campaign status
        GET
      • Get campaign email accounts
        GET
      • Get campaign emails
        GET
      • Set campaign name
        POST
      • Set campaign Schedules
        POST
      • Activate campaign
        POST
      • Pause campaign
        POST
    • 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
    • Email Account
      • List all email accounts in the workspace
        GET
      • Get email account status
        GET
      • Check account vitals
        POST
      • Enable Email account warmup
        POST
      • Pause Email account warmup
        POST
      • Delete Email account
        POST
      • Get Warmup Stats (Individual Account)
        GET
      • Get Warmup Stats (Workspace-Level)
        GET
      • Bulk Add SMTP Accounts
        POST
    • Analytics
      • Get campaign summary
      • Get campaign count (deprecated)
      • Get campaign stats
      • Get all campaigns statistics
    • Unibox
      • Get emails
      • Get count of unread emails
      • Reply to an email
      • Forward an existing email
      • Mark email read
    • Blocklist
      • Get entries in the blocklist
      • Adds entries to the blocklist
      • Delete entries in the blocklist
    • Webhook
      • PlusVibe Webhook Overview
      • Sample Payload - FIRST_EMAIL_REPLIES, ALL_EMAIL_REPLIES, ALL_POSITIVE_REPLIES
      • Sample Payload - LEAD_MARKED_AS_INTERESTED
      • Sample Payload - EMAIL_SENT
      • Add a new webhook
      • List webhooks
      • Delete webhook(s)
    • Tag
      • List Tags
    • For Email Infra Provider Partner
      • List workspaces
      • Initiate Google OAuth login flow
      • Initiate Microsoft OAuth login flow
      • Bulk Add SMTP Accounts (via Username and Password)

    PlusVibe.ai API Documentation

    Welcome to PlusVibe.ai. Let’s get started with getting you authenticated and ready to build! 🛠️

    ChatGPT Logo Get help from ChatGPT#

    Finding your API key 🗝️#

    The API key helps authenticate your incoming requests and is unique per PlusVibe.ai account. The API Key will have access to all workspaces under that PlusVibe.ai account.
    To get to your API key, go to your: https://app.plusvibe.ai/v2/settings/api-access/
    Note: You need to be on the Business Plan to be able to access the API key.

    Authentication#

    When making API requests, include the API key in the request headers as follows:
    x-api-key: YOUR_API_KEY
    This ensures that the requests are authenticated and authorized to interact with your account.

    Required Parameter: workspace_id#

    For all our API endpoints, the workspace_id associated with your API key is required as a parameter. This workspace_id ensures that the requests are directed to the correct workspace within your PlusVibe.ai account. Each workspace is a distinct environment under your account where you can manage leads, campaigns, and other resources.
    Make sure to include the workspace_id in your requests to interact with the correct workspace.

    Rate Limit#

    The rate limit is 5 requests per second. Exceeding this will temporarily block further requests.

    Need more endpoints or enhancements?#

    Feel free to contact us via our in-app chat or email at team@plusvibe.ai and we’ll be happy to look into it.
    Back to PlusVibe.ai
    Modified at 2025-06-13 08:31:43
    Next
    Get workspaces
    Built with