Leads

Create lead

Creates a new lead.

post/leads

Request

  • Base URL: https://app.buildworkpro.com/api/v1
  • URL: https://app.buildworkpro.com/api/v1/leads
  • Auth: HTTP bearer

Headers

Idempotency-Keystring uuid

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

namestring required
stageIdinteger required
contactIdinteger nullable
assignedTointeger nullable
sourcestring nullable
projectType'residential' | 'commercial' | 'industrial' nullable
probabilityinteger
descriptionstring nullable
siteAddressstring nullable
siteCitystring nullable
siteStatestring nullable
siteZipCodestring nullable

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.