- Introduction
- API Reference
- GETList call outcomes
- GETList company categories
- GETList contract types
- GETList custom fields
- GETList industries
- GETList lead sources
- GETList loss reasons
- GETList market sectors
- POSTCreate opportunity
- PATCHUpdate opportunity
- GETList opportunities
- GETGet opportunity
- DELDelete opportunity
- GETList opp stages
Call Outcome
Company Category
Contract Type
Custom Field
Industry
Lead Source
Loss Reason
Market Sector
Opportunity
Opp Stage
Create opportunity
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Company ID to be associated with this opportunity
Opp Stage ID to be associated with this opportunity
Total dollar amount
User ID to be associated with this opportunity
Contact ID to be associated with this opportunity
Contract Type ID to be associated with this opportunity
Company ID working as design team for this opportunity
Lead Source ID to be associated with this opportunity
Loss Reason ID to be associated with this opportunity
Market Sector ID to be associated with this opportunity
curl --request POST \
--url https://api.buildr.com/api/2023-01/opportunities \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"opportunity": {
"name": "Culver High Rise",
"company_id": "753",
"opp_stage_id": "693",
"amount": 10000000,
"probability": 0.5,
"award_date": "2023-06-15",
"bid_due_date": "2023-05-22",
"start_date": "2023-09-04",
"end_date": "2024-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",
"design_team_id": "753",
"lead_source_id": "346",
"loss_reason_id": "254",
"market_sector_id": "902"
}
}'
{
"opportunity": {
"id": "787",
"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,
"award_date": "2023-06-15",
"bid_due_date": "2023-05-22",
"start_date": "2023-09-04",
"end_date": "2024-06-30",
"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>"
},
"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"
},
"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"
},
"opp_stage": {
"id": "693",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>",
"category": "open"
},
"custom_fields": {}
}
}
Headers
Body
Company ID to be associated with this opportunity
Opp Stage ID to be associated with this opportunity
Total dollar amount
AU
, CA
, GB
, IS
, NZ
, UK
, US
User ID to be associated with this opportunity
Contact ID to be associated with this opportunity
Contract Type ID to be associated with this opportunity
Company ID working as design team for this opportunity
Lead Source ID to be associated with this opportunity
Loss Reason ID to be associated with this opportunity
Market Sector ID to be associated with this opportunity
Response
pursuit
, upcoming
, active
, complete
, lost
AU
, CA
, GB
, IS
, NZ
, UK
, US
open
, won
, lost
curl --request POST \
--url https://api.buildr.com/api/2023-01/opportunities \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"opportunity": {
"name": "Culver High Rise",
"company_id": "753",
"opp_stage_id": "693",
"amount": 10000000,
"probability": 0.5,
"award_date": "2023-06-15",
"bid_due_date": "2023-05-22",
"start_date": "2023-09-04",
"end_date": "2024-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",
"design_team_id": "753",
"lead_source_id": "346",
"loss_reason_id": "254",
"market_sector_id": "902"
}
}'
{
"opportunity": {
"id": "787",
"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,
"award_date": "2023-06-15",
"bid_due_date": "2023-05-22",
"start_date": "2023-09-04",
"end_date": "2024-06-30",
"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>"
},
"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"
},
"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"
},
"opp_stage": {
"id": "693",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>",
"category": "open"
},
"custom_fields": {}
}
}