POST /rest/v1.0/project/{project_id}/email_communications
Creates a email communication on a given project
Servers
- https://api.procore.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
project_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 |
---|---|---|---|
topic_id |
Integer | Yes |
Topic ID |
topic_type |
String | Yes |
The type of the topic to be associated with the communication Possible values:
|
Request body fields
Name | Type | Required | Description |
---|---|---|---|
communication |
Object | Yes | |
communication.subject |
String | No |
Subject of the communication |
email |
Object | Yes | |
email.file_version_ids[] |
Array | No |
File version IDs |
email.distribution_ids[] |
Array | No |
An array of IDs of the Distributions of the topic |
email.prostore_file_ids[] |
Array | No |
Prostore file IDs |
email.form_ids[] |
Array | No |
Form IDs |
email.bcc_distribution_ids[] |
Array | No |
User IDs on the email BCC distribution |
email.image_ids[] |
Array | No |
Image IDs |
email.upload_ids[] |
Array | No |
Upload UUIDs |
email.cc_distribution_ids[] |
Array | No |
User IDs on the email CC distribution |
email.body |
String | No |
Body of the email |
email.drawing_revision_ids[] |
Array | No |
Drawing revision IDs |
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.