PATCH /rest/v1.0/companies/{company_id}/files/{id}
Update a specific File (creates a new file version).
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
ID of the File |
company_id |
Integer | Yes |
Unique identifier for the company. |
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. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
file |
Object | Yes | |
file.parent_id |
Integer | No |
The ID of the parent folder to move the file to |
file.name |
String | No |
The Name of the file |
file.description |
String | No |
A description of the file |
file.upload_uuid |
String | No |
UUID referencing a previously completed Upload. This is the recommended approach for file uploads. See Company Uploads or Project Uploads endpoints for instructions on how to use uploads. You should not use both data and upload_uuid fields in the same request. |
file.explicit_permissions |
Boolean | No |
Set file to private (true/false) |
file.is_tracked |
Boolean | No |
Status if a file should be tracked (true/false) Default value: false |
file.checked_out_until |
String | No |
Check out a file until the specified time. Admins may reset checkout by sending "null" |
file.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. |
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.