Lead
Update lead
Call Outcome
Company Category
Contract Type
Custom Field
Delivery Method
Industry
Lead Source
Loss Reason
Market Sector
Project Stages
Task List
Tender Type
Webhook Message
Lead
Update lead
PATCH
/
api
/
2023-01
/
leads
/
{id}
curl --request PATCH \
--url https://api.buildr.com/api/2023-01/leads/{id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"lead": {
"archived_at": "2023-02-14T18:13:00Z",
"archived_by_id": "953",
"assigned_to_id": "953",
"company_id": "753",
"construction_duration": 4,
"construction_duration_unit": "days",
"contact_id": "144",
"contract_type_id": "721",
"delivery_method_id": "306",
"description": "We have to close this one!",
"division_id": "689",
"estimated_start_date": "2023-09-04",
"lead_source_id": "346",
"market_sector_id": "902",
"name": "Gateway Logistics Center",
"priority": true,
"snooze_until": "2023-02-14T18:13:00Z",
"square_feet": 1200,
"tender_type_id": "588",
"units": 24,
"value_in_cents": 2999,
"work_scope": "new_construction",
"required": "<any>"
}
}'
{
"lead": {
"id": "966",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Gateway Logistics Center",
"description": "We have to close this one!",
"priority": true,
"value_in_cents": 2999,
"estimated_start_date": "2023-09-04",
"construction_duration": 4,
"construction_duration_unit": "days",
"square_feet": 1200,
"units": 24,
"archived_at": "2023-02-14T18:13:00Z",
"snooze_until": "2023-02-14T18:13:00Z",
"work_scope": "new_construction",
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
},
"assigned_to": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"archived_by": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"company": {
"id": "101",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>",
"website": "<string>"
},
"contact": {
"id": "418",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Austin",
"last_name": "Reaves",
"name": "Austin Reaves",
"email": "austin.reaves@example.com"
},
"contract_type": {
"id": "721",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Design/Build"
},
"created_by": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"delivery_method": {
"id": "306",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Design Build"
},
"division": {
"id": "689",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>"
},
"lead_source": {
"id": "346",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Website"
},
"market_sector": {
"id": "902",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Education"
},
"tender_type": {
"id": "588",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Open"
}
}
}
Headers
Path Parameters
Body
application/json
Response
200 - application/json
Successful Response
The response is of type object
.
curl --request PATCH \
--url https://api.buildr.com/api/2023-01/leads/{id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"lead": {
"archived_at": "2023-02-14T18:13:00Z",
"archived_by_id": "953",
"assigned_to_id": "953",
"company_id": "753",
"construction_duration": 4,
"construction_duration_unit": "days",
"contact_id": "144",
"contract_type_id": "721",
"delivery_method_id": "306",
"description": "We have to close this one!",
"division_id": "689",
"estimated_start_date": "2023-09-04",
"lead_source_id": "346",
"market_sector_id": "902",
"name": "Gateway Logistics Center",
"priority": true,
"snooze_until": "2023-02-14T18:13:00Z",
"square_feet": 1200,
"tender_type_id": "588",
"units": 24,
"value_in_cents": 2999,
"work_scope": "new_construction",
"required": "<any>"
}
}'
{
"lead": {
"id": "966",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Gateway Logistics Center",
"description": "We have to close this one!",
"priority": true,
"value_in_cents": 2999,
"estimated_start_date": "2023-09-04",
"construction_duration": 4,
"construction_duration_unit": "days",
"square_feet": 1200,
"units": 24,
"archived_at": "2023-02-14T18:13:00Z",
"snooze_until": "2023-02-14T18:13:00Z",
"work_scope": "new_construction",
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
},
"assigned_to": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"archived_by": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"company": {
"id": "101",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>",
"website": "<string>"
},
"contact": {
"id": "418",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Austin",
"last_name": "Reaves",
"name": "Austin Reaves",
"email": "austin.reaves@example.com"
},
"contract_type": {
"id": "721",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Design/Build"
},
"created_by": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"delivery_method": {
"id": "306",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Design Build"
},
"division": {
"id": "689",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>"
},
"lead_source": {
"id": "346",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Website"
},
"market_sector": {
"id": "902",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Education"
},
"tender_type": {
"id": "588",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Open"
}
}
}