Karia
ReferencesOpenapiLeads

Convert a lead to a deal

POST
/organisation/{orgId}/workspace/{workspaceId}/origination/lead/{leadId}/estimate/{estimateId}/convert

Convert a lead estimate into an origination deal in the specified organisation and workspace.

Authorization

ApiKeyAuth
x-api-key<token>

API key for authentication

In: header

Path Parameters

workspaceId*integer
Range0 < value <= 9007199254740991
leadId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
estimateId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
orgId*string

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

curl -X POST "https://example.com/organisation/string/workspace/1/origination/lead/string/estimate/string/convert" \  -H "Content-Type: application/json" \  -d '{    "employerName": "string",    "payrollCycle": "weekly",    "fbtMethod": "statutory",    "contactId": "string"  }'
{  "dealId": 0,  "quoteId": 0}

Get a lead GET

Get a lead in the specified organisation and workspace.

Create a lead POST

Create a lead in the specified organisation and workspace.