v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Workflows

Create a Comment on a Workflow

Creates a comment in the specified workflow's activity feed.

post/workflows/{id}/comment

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Request body

commentstring required

addUsersToWorkflowboolean

Must be set to true if mentioning users who are not participants on the workflow.

repliedToActivityFeedMessageIdstring

Use to specify the comment to reply to

Example request

{
  "creator": {
    "email": "example@example.com"
  }
}

Response

204

object required