API Reference
  1. Viv Public API
  2. Leads

Close a lead

post
https://{apiHost}/api/v2/public/leads//status/closed

Close a lead with success or failure status. This endpoint records the
outcome only — it does not create a client. Use POST /leads/{leadId}/convert
to create a client from a qualified lead.

For SUCCESS: Lead closed as won (no client created by this endpoint)
For FAILED: Lead did not convert (lost opportunity)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique lead identifier

Body Params
string
enum
required

Closing outcome. Use GET /config/statuses for valid values.

Allowed:
string

Attribute ID for closing reason. Use GET /config/attributes?type=closingReason to get valid options.

Response

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?