Create a lead

Create a lead 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

orgId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

firstName*string

Length1 <= length

lastName*string

Length1 <= length

middleName?|null

email?string

Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

phone?string

Match^\+[1-9]\d{6,14}$

status?string

Default"new"

Value in

"new"
"estimating"
"converted"
"not_proceeding"
"archived"

externalSource?string

Length1 <= length

externalId?string

Length1 <= length

followUpDate?string

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

assigneeIds?array<>

contactId?string

Length1 <= length

contactReferenceId?string

Length1 <= length

quickEstimateId?|null

notes?string

Lengthlength <= 512

Response Body

`application/json`

curl -X POST "https://example.com/organisation/string/workspace/1/origination/lead" \  -H "Content-Type: application/json" \  -d '{    "firstName": "string",    "lastName": "string"  }'

{  "id": "string",  "referenceId": "string",  "status": "string",  "firstName": "string",  "lastName": "string",  "middleName": "string",  "email": "string",  "phone": "string",  "externalSource": "string",  "externalId": "string",  "followUpDate": "string",  "assigneeIds": [    "string"  ],  "contactId": "string",  "contactReferenceId": "string",  "createdAt": "string",  "createdBy": "string",  "deletedAt": "string",  "deletedBy": "string",  "lastUpdatedAt": "string",  "lastUpdatedBy": "string",  "lastIngestAt": "string",  "notes": "string",  "isMatched": false,  "message": "Lead created"}

Create a lead

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`