Upgrade a prospect customer
Upgrades a customer from prospect to active status. Use this when a sales prospect converts and should receive full dark-web monitoring.
For the prospecting workflow and redaction rules, see Prospecting.
Header Parameters
Partner organization identifier
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/upgrade" \ -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 upgraded successfully", "customerId": "550e8400-e29b-41d4-a716-446655440000", "status": "active"}After upgrade, the customer is scheduled for ongoing monitoring. Breach API responses and webhook payloads change from the redacted prospect format — limited to uuid, emails, and resolved per breach — to the full detail available for active customers.
Behaviour notes
- Only customers with
status: "prospect"can be upgraded through this endpoint. - Customers in
inactivestatus should use Reactivate customer instead. - Upgrade is idempotent in intent but returns
409if the customer is alreadyactive. - Billing, assets, and plan configuration set at onboard time are preserved; upgrade only changes monitoring status and scan behaviour.
Related
Reactivate a customer POST
Reactivates an inactive customer in the SafeWeb platform by setting their status to active. The customer must belong to the authenticated partner organization. Requires authentication via SW-PARTNER-ID and SW-API-KEY headers. Accepts a partner or distributor API key.
Downgrade an active customer POST
Transitions a customer from active to prospect status, returning them to prospecting mode with redacted breach data. The customer must belong to the authenticated partner organization. Requires authentication via SW-PARTNER-ID and SW-API-KEY headers. Accepts a partner or distributor API key.