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.

Request

POST /api/v1/integrations/customer/downgrade

Headers

HeaderRequiredDescription
SW-PARTNER-IDYesPartner organization identifier
SW-API-KEYYesPartner or distributor API key
Content-TypeYesapplication/json

Body

FieldTypeRequiredDescription
customerIdstringYesUUID of the active customer to downgrade

Example

curl -X POST https://connect.safeweb.co/api/v1/integrations/customer/downgrade \
  -H "Content-Type: application/json" \
  -H "SW-PARTNER-ID: your-partner-id" \
  -H "SW-API-KEY: your-api-key" \
  -d '{
    "customerId": "550e8400-e29b-41d4-a716-446655440000"
  }'

Responses

200 — Downgraded successfully

{
  "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.

Error responses

StatusConditionExample error message
400Invalid JSON or missing customerIdValidation failed: customerId: Customer ID is required
401Missing or invalid credentialsFailed to verify org API key
404Customer not found or does not belong to partnerCustomer not found or does not belong to partner
409Customer is already a prospectCustomer is already a prospect
422Customer is not active (e.g. inactive or dormant)Customer cannot be downgraded: customer is not active
500Server errorFailed to downgrade customer

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.

On this page