Sign in

v5

OpenAPI 3.1.02026-07-31129337684.6 KB
Workflow Runs

Add Comment To Workflow Run

Endpoint to add a comment to a workflow run.

post/workflows/v1/workflow-runs/{workflow_run_id}/comments

Path parameters

workflow_run_idstring required
Example:5eb7cf5a86d9755df3a6c593

Request body

logical_idstring nullable

Unique identifier for the comment

contentstring nullable

Content of the comment

createdBystring nullable

ID of the user who created this edge

updatedBystring nullable

ID of the user who last updated this edge

createdAtstring date-time
updatedAtstring date-time

Example request

{
  "createdBy": "5eb7cf5a86d9755df3a6c593",
  "updatedBy": "5eb7cf5a86d9755df3a6c593"
}

Response

Successful Response

workflow_deletedboolean

True when the workflow backing this run no longer exists (was deleted).