PlusVibe.ai
  1. Campaign
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
    • Update Campaign
      PATCH
  • 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
    • Sample Payload - BOUNCED_EMAIL
    • 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)
  1. Campaign

Update Campaign

PATCH
https://api.plusvibe.ai/api/v1/campaign/update/campaign
This is a PATCH endpoint to update an existing campaign.
Only the fields explicitly provided in the request body will be updated.
Any fields not included will retain their existing values.
This allows for partial updates without affecting other campaign data.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.plusvibe.ai/api/v1/campaign/update/campaign' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workspace_id": "68626ec969bf94f59f8c5c9d",
    "campaign_id": "68626ec969bf94f59f8c5c9e",
    "camp_name": "New Campaign Name",
    "status": "PAUSED",
    "schedules": [
        {
            "daily_limit": 1000,
            "daily_limit_new_lead": 500,
            "start_date": "2025-08-10",
            "end_date": "",
            "days": {
                "1": true,
                "2": true,
                "3": true,
                "4": true,
                "5": true
            },
            "timezone": "Asia/Hong_Kong",
            "timing": {
                "from": "09:00",
                "to": "18:00"
            }
        }
    ],
    "sequences": [
        {
            "step": 1,
            "wait_time": 1,
            "variations": [
                {
                    "variation": "A",
                    "subject": "this is step 1A Subject",
                    "name": "",
                    "body": "<div>this is step 1A body</div>"
                },
                {
                    "variation": "B",
                    "subject": "this is step 1B Subject",
                    "name": "",
                    "body": "<div>this is step 1B body</div>"
                }
            ]
        },
        {
            "step": 2,
            "wait_time": 1,
            "variations": [
                {
                    "variation": "A",
                    "subject": "",
                    "name": "",
                    "body": "<div>this is step 2A body</div>"
                }
            ]
        }
    ],
    "first_wait_time": 60,
    "email_accounts": [
        "68626ec969bf94f59f8c5c5e",
        "68626ec969bf94f59f8c5c2e"
    ],
    "send_priority": 1,
    "ignore_mailbox_limit": 0,
    "bounce_rate_limit": 5,
    "opportunity_val": 1000,
    "template_id": "68626ec969bf94f59f8c5c3e",
    "unlink_template": "no",
    "stop_on_lead_replied": "yes",
    "is_emailopened_tracking": "yes",
    "is_unsubscribed_link": "no",
    "send_as_txt": "no",
    "exclude_ooo": "yes",
    "is_acc_based_sending": "no",
    "is_pause_on_bouncerate": "yes",
    "send_risky_email": "no",
    "unsub_blocklist": "no",
    "other_email_acc": "no",
    "is_esp_match": "yes"
}'
Response Response Example
{
    "id": "string",
    "workspace_id": "string",
    "camp_name": "string",
    "status": "string",
    "updated_at": "2019-08-24T14:15:22Z"
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Campaign updated successfully
Body

🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Modified at 2025-07-28 22:32:06
Previous
Pause campaign
Next
Add leads to a campaign
Built with