Skip to content
BuildWorkPro Docs

Create lead

POST
/leads

Creates a new lead.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string

Request Body

Section titled “Request Body ”
object
name
required
string
>= 1 characters
stageId
required
integer
contactId
integer | null
assignedTo
integer | null
source
string | null
projectType
string | null
Allowed values: residential commercial industrial
estimatedValue
Any of:
string
probability
integer
<= 100
expectedCloseDate
Any of:
string format: date-time
description
string | null

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

object
data
required
object
id
required
integer
name
required
string
contactId
required
integer | null
stageId
required
integer
assignedTo
required
integer | null
source
required
string | null
projectType
required
string | null
estimatedValue
required
string | null
probability
required
integer | null
expectedCloseDate
required
Any of:
string format: date-time
description
required
string | null
createdAt
required
Any of:
string format: date-time
updatedAt
required
Any of:
string format: date-time
meta
required
object
request_id

Server-generated request identifier

string
pagination
object
cursor
required

Opaque cursor for the next page; null when no more results

string | null
has_more
required

Whether more pages are available after this one

boolean
count
required

Items in this page

integer

422

Section titled “422 ”

Validation failed

object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string