PATCH /rest/v1.0/projects/{id}
Update information for an existing project.
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.
Servers
- https://api.procore.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
id |
Integer | Yes |
Unique identifier for the project. |
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 unique identifier for the Company the Project is associated with. |
project |
Object | Yes | |
project.project_bid_type_id |
Integer | No |
The identifier for the Project Bid Type |
project.store_number |
String | No |
Store Number of the Project |
project.description |
String | No |
The description for the project |
project.origin_data |
String | No |
An external third-party data string associated with the Project |
project.accounting_project_number |
String | No |
Accounting Project Number of the Project |
project.city |
String | No |
The City in which the project is located |
project.origin_code |
String | No |
An external third-party code associated with the Project |
project.square_feet |
Integer | No |
The total square footage of the Project |
project.custom_field_%{custom_field_definition_id} |
No |
Value of the custom field. The data type of the value passed in corresponds with the data_type of the Custom Field Definition. For a lov_entry data_type the value passed in should be the ID of one of the Custom Field Definition's LOV Entries. For a lov_entries data_type the value passed in should be an array of IDs of the Custom Field Definition's LOV Entries. |
|
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.flag |
String | No |
The flag for the project Possible values:
|
project.fax |
String | No |
The fax number for the project |
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 Active status of the project. Must be true or false. Default value: true |
project.start_date |
String | No |
The date that the contract for the project is signed. Note: this field is a replacement to estimated_start_date and will mirror its value. |
project.designated_market_area |
String | No |
Designated Market Area of the Project |
project.warranty_end_date |
String | No |
The end date for the Project Warranty |
project.project_stage_id |
Integer | No |
The identifier for the Project Stage |
project.zip |
String | No |
The postal code for the Project |
project.origin_id |
String | No |
An 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 identifier for the Project Program ID |
project.delivery_method |
String | No |
The delivery method of a project. Possible values:
|
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 to estimated_value and will mirror its value. |
project.standard_cost_code_list_id |
Integer | No |
The identifier for the Standard Cost Code List |
project.office_id |
Integer | No |
The identifier for the Project Office |
project.public_notes |
String | No |
The public notes for the Project |
project.sector |
String | No |
The sector of a project. Possible values:
|
project.time_zone |
String | No |
The timezone the Project is located in |
project.project_template_id |
Integer | No |
The identifier for the Project Template as designated by another Project on this company.
It must be a Project that is a Template defined by template: |
project.department_ids[] |
Array | No |
The identifiers for the Departments the Project belongs to.
The array should always represent all Departments, so if you have |
project.project_region_id |
Integer | No |
The identifier for the Project Region |
project.erp_integrated |
Boolean | No |
This project is integrated with ERP Default value: false |
project.work_scope |
String | No |
The work scope of a project. Possible values:
|
project.country_code |
String | No |
The two character code that represents the country in which the project is located (ISO-3166 Alpha-2 format) |
project.completion_date |
String | No |
The date that all parties agree the project meets or must meet “substantial completion”. Note: this field is a replacement to estimated_completion_date and will mirror its value. |
project.warranty_start_date |
String | No |
The start date for the Project Warranty |
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 | No |
The name of the project |
project.project_type_id |
Integer | No |
The identifier for the Project Type |
project.image_id |
Integer | No |
The identifier for the project image |
project.state_code |
String | No |
The code that represents the Project State (ISO-3166 Alpha-2 format) |
project.phone |
String | No |
The telephone number for the Project |
project.parent_job_id |
Integer | No |
The identifier for the Project's Parent Job |
project.county |
String | No |
The County in which the project is located |
project.project_owner_type_id |
Integer | No |
The identifier for the Project Owner Type |
project.address |
String | No |
The street address for the Project location |
project.project_number |
String | No |
The number for the Project |
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.