PATCH /rest/v1.0/projects/sync
Create or update a batch of projects. See Using Sync Actions for additional information.
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
Please be advised to not use the sync endpoint for bulk project creation due to potential performance bottlenecks.
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 |
company_id |
Integer | No |
Unique identifier for the company. |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
updates[] |
Array | Yes | |
updates[].project_bid_type_id |
Integer | No |
The project bid type identifier. |
updates[].store_number |
String | No |
The project store number. |
updates[].description |
String | No |
The project description. |
updates[].origin_data |
String | No |
External third-party data string associated with the project. |
updates[].accounting_project_number |
String | No |
The project accounting project number. |
updates[].city |
String | No |
The city where the project is located. |
updates[].square_feet |
Integer | No |
The total square footage of the project. |
updates[].id |
Integer | No |
Unique identifier for the project. |
updates[].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. |
updates[].flag |
String | No |
The project flag. Possible values:
|
updates[].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 |
updates[].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. |
updates[].active |
Boolean | No |
The project active status. Default value: true |
updates[].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. |
updates[].designated_market_area |
String | No |
The project designated market area. |
updates[].warranty_end_date |
String | No |
The project warranty end date. |
updates[].project_stage_id |
Integer | No |
The project stage identifier. |
updates[].zip |
String | No |
The project postal code. |
updates[].origin_id |
String | No |
External third-party identifier for the project. |
updates[].program_id |
Integer | No |
The project program identifier. |
updates[].delivery_method |
String | No |
The delivery method of a project. Possible values:
|
updates[].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. |
updates[].office_id |
Integer | No |
The project office identifier. |
updates[].public_notes |
String | No |
The public notes for the project. |
updates[].sector |
String | No |
The sector of a project. Possible values:
|
updates[].time_zone |
String | No |
The timezone where the project is located. |
updates[].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 |
updates[].department_ids[] |
Array | No |
The department ids the project is associated with.
The array should represent all departments, so if the current value is |
updates[].project_region_id |
Integer | No |
The project region id of the project. |
updates[].work_scope |
String | No |
The work scope of a project. Possible values:
|
updates[].country_code |
String | No |
The country code (ISO-3166 Alpha-2 format) where the project is located. |
updates[].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. |
updates[].warranty_start_date |
String | No |
The project warranty start date. |
updates[].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. |
updates[].name |
String | No |
The project name. |
updates[].project_type_id |
Integer | No |
The project type identifier. |
updates[].image_id |
Integer | No |
The project image identifier. |
updates[].state_code |
String | No |
The state code (ISO-3166 Alpha-2 format) where the project is located. |
updates[].phone |
String | No |
The project telephone number. |
updates[].project_owner_type_id |
Integer | No |
The project owner type identifier. |
updates[].address |
String | No |
The street address of the project. |
updates[].project_number |
String | No |
The project number. |
company_id |
Integer | Yes |
The company identifier the project is associated with.
Required only if |
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.