Project
Create project
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
Project
Create project
POST
/
api
/
2023-01
/
projects
curl --request POST \
--url https://api.buildr.com/api/2023-01/projects \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"project": {
"name": "Culver High Rise",
"company_id": "753",
"probability": 0.5,
"project_stage_id": "710",
"close_type": "lost",
"award_date": "2023-06-15",
"bid_due_date": "2023-05-22",
"bid_due_at": "2023-05-22T14:30:00Z",
"start_date": "2023-09-04",
"end_date": "2025-06-30",
"description": "A project to build a high rise in Culver City",
"square_feet": 100000,
"units": 80,
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
},
"assigned_to_id": "953",
"contact_id": "144",
"contract_type_id": "721",
"lead_source_id": "346",
"loss_reason_id": "254",
"market_sector_id": "902",
"delivery_method_id": "306",
"tender_type_id": "588",
"work_scope": "new_construction"
}
}'{
"project": {
"id": "372",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Culver High Rise",
"stage_age": 20,
"probability": 0.5,
"description": "A project to build a high rise in Culver City",
"project_duration": 12,
"pursuit_duration": 90,
"project_number": "23-1329",
"project_status": "active",
"square_feet": 100000,
"price_per_square_foot": 100,
"units": 80,
"price_per_unit": 125000,
"external_id": "external-id-123",
"amount": 10000000,
"close_type": "lost",
"award_date": "2023-06-15",
"bid_due_date": "2023-05-22",
"bid_due_at": "2023-05-22T14:30:00Z",
"bid_due_at_includes_time": true,
"start_date": "2023-09-04",
"end_date": "2025-06-30",
"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"
},
"company": {
"id": "101",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>",
"website": "<string>"
},
"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"
},
"division": {
"id": "689",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>"
},
"import": {
"id": "456",
"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"
},
"loss_reason": {
"id": "254",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Project Canceled"
},
"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"
},
"delivery_method": {
"id": "306",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Design Build"
},
"project_stage": {
"id": "710",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Proposal",
"category": "open"
},
"custom_fields": {}
}
}Headers
Body
application/json
Company ID to be associated with this project
Example:
"753"
Example:
"Culver High Rise"
Example:
0.5
Project Stage ID to be associated with this project
Example:
"710"
Close type of the project
Available options:
lost, cancelled, did_not_pursue Example:
"lost"
Example:
"2023-06-15"
Use bid_due_date to specify a date, but use bid_due_at if you also want to include a time.
Example:
"2023-05-22"
Use bid_due_at to specify a time, but use bid_due_date if you only want to specify a date.
Example:
"2023-05-22T14:30:00Z"
Example:
"2023-09-04"
Example:
"2025-06-30"
Example:
"A project to build a high rise in Culver City"
Example:
100000
Example:
80
Example:
"123 Main St"
Example:
"Apt 1"
Example:
"Los Angeles"
Example:
"90001"
Available options:
AU, CA, GB, IS, NZ, UK, US Example:
"US"
Example:
"CA"
User ID to be associated with this project
Example:
"953"
Contact ID to be associated with this project
Example:
"144"
Contract Type ID to be associated with this project
Example:
"721"
Lead Source ID to be associated with this project
Example:
"346"
Loss Reason ID to be associated with this project
Example:
"254"
Market Sector ID to be associated with this project
Example:
"902"
Delivery Method ID to be associated with this project
Example:
"306"
Tender Type ID to be associated with this project
Example:
"588"
Available options:
new_construction, renovation, maintenance Example:
"new_construction"
Response
201 - application/json
Created Response
Example:
"372"
Example:
"2023-02-14T18:13:00Z"
Example:
"2023-04-03T20:16:30Z"
Example:
"Culver High Rise"
Example:
20
Example:
0.5
Example:
"A project to build a high rise in Culver City"
Example:
12
Example:
90
Example:
"23-1329"
Available options:
pursuit, upcoming, active, complete, closed Example:
"active"
Example:
100000
Example:
100
Example:
80
Example:
125000
Example:
"external-id-123"
Example:
10000000
Available options:
lost, cancelled, did_not_pursue Example:
"lost"
Example:
"2023-06-15"
Example:
"2023-05-22"
Example:
"2023-09-04"
Example:
"2025-06-30"
Example:
"123 Main St"
Example:
"Apt 1"
Example:
"Los Angeles"
Example:
"90001"
Available options:
AU, CA, GB, IS, NZ, UK, US Example:
"US"
Example:
"CA"
Example:
"953"
Example:
"2023-02-14T18:13:00Z"
Example:
"2023-04-03T20:16:30Z"
Example:
"Russell"
Example:
"Westbrook"
Example:
"Russell Westbrook"
Example:
"russell.westbrook@example.com"
Example:
"953"
Example:
"2023-02-14T18:13:00Z"
Example:
"2023-04-03T20:16:30Z"
Example:
"Russell"
Example:
"Westbrook"
Example:
"Russell Westbrook"
Example:
"russell.westbrook@example.com"
Example:
"710"
Example:
"2023-02-14T18:13:00Z"
Example:
"2023-04-03T20:16:30Z"
Example:
"Proposal"
Available options:
open, won Example:
"2023-05-22T14:30:00Z"
Returns false when the time and timezone portion of bid_due_at should be ignored. Use the entire bid_due_at value when true.
Example:
true
Available options:
new_construction, renovation, maintenance Example:
"new_construction"
curl --request POST \
--url https://api.buildr.com/api/2023-01/projects \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"project": {
"name": "Culver High Rise",
"company_id": "753",
"probability": 0.5,
"project_stage_id": "710",
"close_type": "lost",
"award_date": "2023-06-15",
"bid_due_date": "2023-05-22",
"bid_due_at": "2023-05-22T14:30:00Z",
"start_date": "2023-09-04",
"end_date": "2025-06-30",
"description": "A project to build a high rise in Culver City",
"square_feet": 100000,
"units": 80,
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
},
"assigned_to_id": "953",
"contact_id": "144",
"contract_type_id": "721",
"lead_source_id": "346",
"loss_reason_id": "254",
"market_sector_id": "902",
"delivery_method_id": "306",
"tender_type_id": "588",
"work_scope": "new_construction"
}
}'{
"project": {
"id": "372",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Culver High Rise",
"stage_age": 20,
"probability": 0.5,
"description": "A project to build a high rise in Culver City",
"project_duration": 12,
"pursuit_duration": 90,
"project_number": "23-1329",
"project_status": "active",
"square_feet": 100000,
"price_per_square_foot": 100,
"units": 80,
"price_per_unit": 125000,
"external_id": "external-id-123",
"amount": 10000000,
"close_type": "lost",
"award_date": "2023-06-15",
"bid_due_date": "2023-05-22",
"bid_due_at": "2023-05-22T14:30:00Z",
"bid_due_at_includes_time": true,
"start_date": "2023-09-04",
"end_date": "2025-06-30",
"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"
},
"company": {
"id": "101",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>",
"website": "<string>"
},
"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"
},
"division": {
"id": "689",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>"
},
"import": {
"id": "456",
"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"
},
"loss_reason": {
"id": "254",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Project Canceled"
},
"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"
},
"delivery_method": {
"id": "306",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Design Build"
},
"project_stage": {
"id": "710",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Proposal",
"category": "open"
},
"custom_fields": {}
}
}