SafeWeb
Partner API

Downgrade an active customer

Downgrades a customer from active to prospect status. Use this when an active customer should return to prospecting mode without full ongoing monitoring.

For the prospecting workflow and redaction rules, see Prospecting.

POST
/api/v1/integrations/customer/downgrade

Header Parameters

SW-PARTNER-ID*string

Partner organization identifier

SW-API-KEY*string

API authentication key

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/integrations/customer/downgrade" \  -H "SW-PARTNER-ID: string" \  -H "SW-API-KEY: string" \  -H "Content-Type: application/json" \  -d '{    "customerId": "550e8400-e29b-41d4-a716-446655440000"  }'
{  "success": true,  "message": "Customer downgraded successfully",  "customerId": "550e8400-e29b-41d4-a716-446655440000",  "status": "prospect"}

After downgrade, ongoing monitoring stops for this customer. Breach API responses and webhook payloads return to the redacted prospect format — limited to uuid, emails, and resolved per breach.

Behaviour notes

  • Only customers with status: "active" can be downgraded through this endpoint.
  • Customers in inactive status should use Reactivate customer to return to active, then downgrade if needed.
  • Downgrade is idempotent in intent but returns 409 if the customer is already a prospect.
  • Billing, assets, and plan configuration are preserved; downgrade only changes monitoring status and scan behaviour.