POST /rest/v1.0/images
Upload and add a new Image to a Project's Photo Album (Image Category).
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 |
|---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
upload_uuid |
String | No |
UUID referencing a previously completed Upload. This is the recommended approach for image uploads. See Company Uploads or Project Uploads for instructions on how use uploads. You should not use both data and uuid fields in the same request. |
image_name |
String | Yes |
The name of the image file to be uploaded. Required when using an upload_uuid to upload the image. |
image |
Object | Yes |
At least one attribute is required even when an 'upload_uuid' key is provided. If an 'upload_uuid' is not provided above, then the 'data' key must be provided |
image.source |
String | No |
Image source |
image.image_category_id |
Integer | No |
Image Category ID |
image.location_id |
Integer | No |
If you want to use an existing location and you have the ID of that existing location use this. |
image.log_date |
String | No | |
image.description |
String | No |
Image description |
image.provider_type |
String | No |
Provider type. Currently supports only |
image.trade_ids[] |
Array | No |
An array of IDs of the Trades of the Image |
image.private |
Boolean | No |
The Private status of the Image. Defaults to a project configuration. |
image.provider_id |
Integer | No |
Provider ID. Currently supports only MarkupLayer IDs, and should only be used when adding an Image to markup. |
image.mt_location[] |
Array | No |
Use this for creating a new multi-tier or single-tier Location. This will be ignored 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.