POST /rest/v1.0/companies/{company_id}/projects/{project_id}/task_item_comments

Create a new task item comment for a given task_item_id and created_by_id

Servers

Path parameters

Name Type Required Description
project_id Integer Yes

Unique identifier for the project.

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
task_item_comment Object No
task_item_comment.file_version_ids[] Array No

File Versions to attach to the response

task_item_comment.comment String No

The message of the comment

task_item_comment.form_ids[] Array No

Forms to attach to the response

task_item_comment.task_item_id Integer Yes

The task_item associated with the comment

task_item_comment.image_ids[] Array No

Images to attach to the response

task_item_comment.document_management_document_revision_ids[] Array No

PDM document to attach to the response

task_item_comment.attachments[] Array No

Attachments. To upload attachments you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with attachments[] as files.

task_item_comment.upload_ids[] Array No

Uploads to attach to the response

task_item_comment.status String No

The status of the task item at the time the comment is created. Standard users who are assigned to the task item cannot change the status to closed or void.

Possible values:

  • "in_progress"
  • "ready_for_review"
  • "initiated"
  • "closed"
  • "void"
task_item_comment.drawing_revision_ids[] Array No

Drawing Revisions to attach to the response

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.