Skip to content
BuildWorkPro Docs

Update lead

PATCH
/leads/{id}
 
curl --request PATCH \
  --url https://app.buildworkpro.com/api/v1/leads/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "stageId": 1, "contactId": 1, "assignedTo": 1, "source": "example", "projectType": "residential", "estimatedValue": "example", "probability": 1, "expectedCloseDate": "2026-04-15T12:00:00Z", "description": "example", "siteAddress": "example", "siteCity": "example", "siteState": "example", "siteZipCode": "example" }'

Partially updates a lead.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
integer

Header Parameters

Section titled “ Header Parameters ”
Idempotency-Key
string format: uuid
<= 255 characters

Idempotent retry key for mutating operations. The first request with a given key executes normally and BuildWorkPro caches the response. Replaying the same key with the same request body (method + path + JSON body, SHA-256 hashed) returns the cached response without re-executing the mutation. Replaying with a DIFFERENT body returns 409 idempotency_key_reused. The cache TTL is 24 hours; after expiry the key is treated as a new operation. Keys are tenant-scoped. Recommended: a fresh UUID v4 per logical operation.

Request Body

Section titled “ Request Body ”
Media type application/json
object
name
string
>= 1 characters
stageId
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
siteAddress
string | null
siteCity
string | null
<= 255 characters
siteState
string | null
<= 100 characters
siteZipCode
string | null
<= 20 characters

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Updated

Media type application/json
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
siteAddress
string | null
siteCity
string | null
siteState
string | null
siteZipCode
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
Example generated 
{
  "data": {
    "id": 1,
    "name": "example",
    "contactId": 1,
    "stageId": 1,
    "assignedTo": 1,
    "source": "example",
    "projectType": "example",
    "estimatedValue": "example",
    "probability": 1,
    "expectedCloseDate": "2026-04-15T12:00:00Z",
    "description": "example",
    "siteAddress": "example",
    "siteCity": "example",
    "siteState": "example",
    "siteZipCode": "example",
    "createdAt": "2026-04-15T12:00:00Z",
    "updatedAt": "2026-04-15T12:00:00Z"
  },
  "meta": {
    "request_id": "example",
    "pagination": {
      "cursor": "example",
      "has_more": true,
      "count": 1
    }
  }
}

404

Section titled “ 404 ”

Not found

Media type application/problem+json
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
Example generated 
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

422

Section titled “ 422 ”

Validation failed

Media type application/problem+json
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
Example generated 
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}