Update Workspace Settings

PATCH

https://api.plusvibe.ai/api/v1/workspace-settings/update

Partial update: send only the groups (and only the keys inside a group) you want to change; everything else keeps its value.

Rules

blocklist.gsheet_url must be a Google Sheets link (https://docs.google.com/spreadsheets/d/...). The URL is saved immediately and the sheet is verified in the background — if it is not publicly accessible, blocklist.gsheet_sync_error (see GET) is set within a few seconds. Pass "" or null to disconnect the sheet.

Enabling domain_daily_cap requires max_leads_per_day to be set (in the same request or earlier).

ai_lead_labeling.labels and auto_follow_up.labels accept label KEYS only — list valid keys with GET /workspace-settings/lead-labels. auto_follow_up.labels additionally accepts "UNLABELLED" for conversations without a label.

Enabling auto_follow_up requires at least one step and at least one label (in the same request or earlier).

Returns the full updated settings (same shape as GET) plus a status field.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

Updated settings

Bodyapplication/json

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

cURL

Enable auto follow-upCap leads per domain per dayBlocklist channels + Google Sheet

curl --location --request PATCH 'https://api.plusvibe.ai/api/v1/workspace-settings/update' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "workspace_id": "6764274d64169c4e88eec418",
    "auto_follow_up": {
        "is_enabled": "yes",
        "wait_days": 3,
        "labels": [
            "INTERESTED",
            "UNLABELLED"
        ],
        "steps": [
            {
                "body": "<p>Hi {{first_name}}, just floating this back up.</p>",
                "wait_days": 3
            }
        ]
    }
}'

Response Example

200 - Success Example

{
    "status": "Success",
    "blocklist": {
        "apply_on": [
            "AUTO_FOLLOW_UP",
            "MANUAL_REPLY"
        ],
        "gsheet_url": "https://docs.google.com/spreadsheets/d/1AbCdEfG/edit#gid=0",
        "gsheet_sync_error": null
    },
    "domain_daily_cap": {
        "is_enabled": "yes",
        "max_leads_per_day": 3
    },
    "ai_lead_labeling": {
        "labels": [
            "INTERESTED",
            "HOT_LEAD"
        ]
    },
    "auto_follow_up": {
        "is_enabled": "yes",
        "wait_days": 3,
        "labels": [
            "INTERESTED",
            "UNLABELLED"
        ],
        "steps": [
            {
                "body": "<p>Hi {{first_name}}, just floating this back up.</p>",
                "wait_days": 3
            },
            {
                "body": "<p>Any thoughts on my last note?</p>",
                "wait_days": 4
            }
        ]
    }
}

Modified at 2026-08-15 09:43:13

Get Workspace Settings

List Lead Labels