POST /rest/v1.0/projects
Create a new Project in a Procore account. The new project is active by default.
Country and State codes
The country_code
and state_code
parameter values must conform to the ISO-3166 Alpha-2 specification.
See Working with Country Codes for additional information.
Recommendation
For accounts creating a significant number of projects (more than 300), schedule these operations during non-business hours (5 P.M PST - 7 A.M PST) to optimize efficiency. Coordinate the timing with your solution architect for insights into system load and effective resource utilization.
Servers
- https://api.procore.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
run_configurable_validations |
Boolean | No |
If true, validations are run for the corresponding Configurable Field Set. Default value: false |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
company_id |
Integer | Yes |
The company identifier the project is associated with. |
project |
Object | Yes | |
project.project_bid_type_id |
Integer | No |
The project bid type identifier. |
project.store_number |
String | No |
The project store number. |
project.override_end_date_check |
Boolean | No |
This is the property that enables the use of the override_end_date as the Projected Finish Date. |
project.currency_configuration |
Object | No |
This object will initialize the project currency configuration |
project.currency_configuration.exchange_rate_override |
Number | No |
-> This optional parameter is used to populate a fixed initial project to company exchange rate, company exchange rate for the project currency iso code will be used instead if this parameter is missing |
project.currency_configuration.currency_iso_code |
String | Yes |
The currency iso code for the new project, must be available in the company exchange rates list |
project.origin_data |
String | No |
External third-party data string associated with the project. |
project.accounting_project_number |
String | No |
The project accounting project number. |
project.square_feet |
Integer | No |
The total square footage of the project. |
project.estimated_value |
Number | No |
The estimated value of the project. Note: This field is now deprecated and will mirror the value of total_value until it is no longer supported. |
project.enable_copy_of_standard_cost_codes |
Boolean | No |
This property enables the user to copy default standard cost codes during new project creation when it is set to true. However, this flag does not have any impact when using project template, and the company's configuration is set to copy project template cost codes. Default value: false |
project.designated_market_area |
String | No |
The project designated market area. |
project.longitude |
Number | No |
Project longitude |
project.zip |
String | No |
The project postal code. |
project.total_value |
Number | No |
The total amount of construction work performed, planned, or put in place during the project. Note: This field is a replacement of estimated_value and will mirror its value. |
project.office_id |
Integer | No |
The project office identifier. |
project.public_notes |
String | No |
The public notes for the project. |
project.sector |
String | No |
The sector of a project. Possible values:
|
project.department_ids[] |
Array | No |
The department ids the project is associated with.
The array should represent all departments, so if the current value is |
project.erp_integrated |
Boolean | No |
The project will be ERP integrated. Default value: false |
project.country_code |
String | No |
The country code (ISO-3166 Alpha-2 format) where the project is located. |
project.override_start_date |
String | No |
This is the date that the project started and will be displayed on the portfolio page. |
project.estimated_completion_date |
String | No |
The estimated completion date of the project. Note: This field is now deprecated and will mirror the value of completion_date until it is no longer supported. |
project.name |
String | Yes |
The project name. |
project.image_id |
Integer | No |
The project image identifier. |
project.state_code |
String | No |
The state code (ISO-3166 Alpha-2 format) where the project is located. |
project.phone |
String | No |
The project telephone number. |
project.project_owner_type_id |
Integer | No |
The project owner type identifier. |
project.description |
String | No |
The project description. |
project.latitude |
Number | No |
Project latitude |
project.code |
String | No |
The project code. |
project.city |
String | No |
The city where the project is located. |
project.origin_code |
String | No |
External third-party code associated with the project. |
project.flag |
String | No |
The project flag. Possible values:
|
project.estimated_start_date |
String | No |
The estimated start date of the project. Note: This field is now deprecated and will mirror the value of start_date until it is no longer supported. |
project.active |
Boolean | No |
The project active status. Default value: true |
project.start_date |
String | No |
The date that the contract for the project is signed. Note: This field replaces estimated_start_date and will mirror its value. |
project.warranty_end_date |
String | No |
The project warranty end date. |
project.project_stage_id |
Integer | No |
The project stage identifier. |
project.origin_id |
String | No |
External third-party identifier for the project. |
project.locale |
String | No |
The locale for the Project. (Note that your account may not have access to all locales.) Possible values:
|
project.program_id |
Integer | No |
The project program identifier. |
project.delivery_method |
String | No |
The delivery method of a project. Possible values:
|
project.time_zone |
String | No |
The timezone where the project is located. |
project.project_template_id |
Integer | No |
The project template identifier as designated by another project on this company.
It must be a project that is a template defined by |
project.project_region_id |
Integer | No |
The project region id of the project. |
project.override_start_date_check |
Boolean | No |
This is the property that enables the use of the override_start_date as the Actual Start Date. |
project.work_scope |
String | No |
The work scope of a project. Possible values:
|
project.completion_date |
String | No |
The date that all parties agree the project meets or must meet “substantial completion”. Note: This field replaces estimated_completion_date and will mirror its value. |
project.warranty_start_date |
String | No |
The project warranty start date. |
project.override_end_date |
String | No |
This is the date that the project will be finished and will be displayed on the portfolio page. |
project.project_type_id |
Integer | No |
The project type identifier. |
project.parent_job_id |
Integer | No |
The project's parent job identifier. |
project.address |
String | No |
The street address of the project. |
project.project_number |
String | No |
The project number. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.