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"
    },
    "project_number": "23-1329",
    "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

Authorization

string

required

Body

application/json

project

object

project.company_id

string

required

Company ID to be associated with this project

Example:

"753"

project.name

string

Example:

"Culver High Rise"

project.probability

number

Example:

0.5

project.project_stage_id

string

Project Stage ID to be associated with this project

Example:

"710"

project.close_type

enum<string>

Close type of the project

Available options:

lost,

cancelled,

did_not_pursue

Example:

"lost"

project.award_date

string

Example:

"2023-06-15"

project.bid_due_date

string

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"

project.bid_due_at

string

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"

project.start_date

string

Example:

"2023-09-04"

project.end_date

string

Example:

"2025-06-30"

project.description

string

Example:

"A project to build a high rise in Culver City"

project.square_feet

integer

Example:

100000

project.units

integer

Example:

80

project.address

object

project.project_number

string

Example:

"23-1329"

project.assigned_to_id

string

User ID to be associated with this project

Example:

"953"

project.contact_id

string

Contact ID to be associated with this project

Example:

"144"

project.contract_type_id

string

Contract Type ID to be associated with this project

Example:

"721"

project.lead_source_id

string

Lead Source ID to be associated with this project

Example:

"346"

project.loss_reason_id

string

Loss Reason ID to be associated with this project

Example:

"254"

project.market_sector_id

string

Market Sector ID to be associated with this project

Example:

"902"

project.delivery_method_id

string

Delivery Method ID to be associated with this project

Example:

"306"

project.tender_type_id

string

Tender Type ID to be associated with this project

Example:

"588"

project.work_scope

enum<string>

Available options:

new_construction,

renovation,

maintenance

Example:

"new_construction"

Response

201 - application/json

Created Response

project

object

required

project.id

string

required

Example:

"372"

project.created_at

string

required

Example:

"2023-02-14T18:13:00Z"

project.updated_at

string

required

Example:

"2023-04-03T20:16:30Z"

project.name

string

required

Example:

"Culver High Rise"

project.stage_age

integer

required

Example:

20

project.probability

number

required

Example:

0.5

project.description

string

required

Example:

"A project to build a high rise in Culver City"

project.project_duration

integer

required

Example:

12

project.pursuit_duration

integer

required

Example:

90

project.project_number

string

required

Example:

"23-1329"

project.project_status

enum<string>

required

Available options:

pursuit,

upcoming,

active,

complete,

closed

Example:

"active"

project.square_feet

integer | null

required

Example:

100000

project.price_per_square_foot

number | null

required

Example:

100

project.units

integer | null

required

Example:

80

project.price_per_unit

number | null

required

Example:

125000

project.external_id

string | null

required

Example:

"external-id-123"

project.amount

number

required

Example:

10000000

project.close_type

enum<string> | null

required

Available options:

lost,

cancelled,

did_not_pursue

Example:

"lost"

project.award_date

string | null

required

Example:

"2023-06-15"

project.bid_due_date

string | null

required

Example:

"2023-05-22"

project.start_date

string | null

required

Example:

"2023-09-04"

project.end_date

string | null

required

Example:

"2025-06-30"

project.address

object

required

project.assigned_to

object | null

required

project.company

object

required

project.contract_type

object | null

required

project.created_by

object

required

project.division

object | null

required

project.import

object | null

required

project.lead_source

object | null

required

project.loss_reason

object | null

required

project.market_sector

object | null

required

project.tender_type

object | null

required

project.delivery_method

object | null

required

project.project_stage

object | null

required

project.bid_due_at

string | null

Example:

"2023-05-22T14:30:00Z"

project.bid_due_at_includes_time

boolean | null

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

project.work_scope

enum<string>

Available options:

new_construction,

renovation,

maintenance

Example:

"new_construction"

project.custom_fields

object

List market sectors Update project

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"
    },
    "project_number": "23-1329",
    "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": {}
  }
}

Call

Call Outcome

Company

Company Category

Contact

Contract Type

Custom Field

Delivery Method

Industry

Lead

Lead Source

Loss Reason

Market Sector

Project

Project Stages

Task

Task List

Tender Type

User

Workforce

Webhook

Webhook Message

Create project

Headers

Body

Response