Create a Comment on a Workflow

post

https://na1.ironcladapp.com/public/api/v1/workflows/{id}/comments

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

OAuth Scope required: public.workflows.createComments

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique identifier or Ironclad ID of a workflow.

Body Params

Note that user is required when commenting with a legacy bearer token but will be ignored when commenting via an OAuth token. If the token was generated with the Authorization Code grant, the associated token user will be used. If the token was generated with the Client Credentials grant, the required x-as-user-id or 'x-as-user-email` header will be used.

creator

The Ironclad user (must be a user in your Ironclad account) to be used for launching the workflow. This is required when using a legacy bearer token but will be ignored when using an OAuth token. If the token was generated with the Authorization Code grant, the associated token user will be used. If the token was generated with the Client Credentials grant, the required x-as-user-id or x-as-user-email header will be used.

comment

string

required

The comment to be added to the workflow activity feed. To @-mention a user, use the format <@[email protected]>.

addUsersToWorkflow

boolean

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

repliedToActivityFeedMessageId

string

Use to specify a comment to reply to. Message ID can be found via the List All Comments on a Workflow endpoint.

Headers

x-as-user-email

string

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-id

string

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.

Responses

200200

400400