---
title: "Create a Comment on a Workflow"
method: POST
path: "/workflows/{id}/comments"
tags: ["Workflows"]
---

# Create a Comment on a Workflow

`POST /workflows/{id}/comments`

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

**OAuth Scope required:** `public.workflows.createComments`

## Path parameters

- `id` string, required

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Request body

- object — 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` union — 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.
    - object — The Ironclad user (must be a user in your Ironclad account) used to launch the workflow by using the user's email address.
      - `type` string — The type of value used to identify the user.
      - `email` string — The email address of the Ironclad user.
    - object — The Ironclad user (must be a user in your Ironclad account) used to launch the workflow by using the user's ID.
      - `type` string — The type of value used to identify the user.
      - `id` string — The user ID of the Ironclad user.
  - `comment` string, required — The comment to be added to the workflow activity feed. To @-mention a user, use the format `<@john.doe@example.com>`.
  - `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](https://developer.ironcladapp.com/reference/list-all-comments-in-a-workflow) endpoint.

## Response `200`

200

- ActivityFeedComment — A comment-type item on the workflow activity feed
  - `id` string, required — Unique ID of the comment-type activity feed item
  - `commentMessage` string, required — The comment message
  - `timestamp` string, date-time, required — When the comment was posted (ISO 8601 format)
  - `isExternal` boolean — Whether the comment was made by an external user
  - `author` union, required — The author of an activity feed item
    - object — An internal author of an activity feed item
      - `type` 'internalUser', required — The type of author
      - `companyName` string, required — The company name of the author
      - `displayName` string — The display name of the author
      - `email` string — The email of the author
      - `userId` string — The user ID of the author
    - object — An external author of an activity feed item (typically a counterparty)
      - `type` 'externalUser', required — The type of author
      - `companyName` string, required — The company name of the author
      - `displayName` string — The display name of the author
      - `email` string — The email of the author
    - object — An integration author of an activity feed item
      - `type` 'integration', required — The type of author
      - `displayName` string, required — The display name of the integration
    - object — A system author of an activity feed item
      - `type` 'system', required — The type of author
      - `displayName` 'Ironclad', required — The display name of the system
  - `repliedTo` object — The comment that this comment is a reply to
    - `item` string, required — The ID of the comment that this comment is a reply to
    - `itemAuthor` union, required — The author of an activity feed item
      - object — An internal author of an activity feed item
        - `type` 'internalUser', required — The type of author
        - `companyName` string, required — The company name of the author
        - `displayName` string — The display name of the author
        - `email` string — The email of the author
        - `userId` string — The user ID of the author
      - object — An external author of an activity feed item (typically a counterparty)
        - `type` 'externalUser', required — The type of author
        - `companyName` string, required — The company name of the author
        - `displayName` string — The display name of the author
        - `email` string — The email of the author
      - object — An integration author of an activity feed item
        - `type` 'integration', required — The type of author
        - `displayName` string, required — The display name of the integration
      - object — A system author of an activity feed item
        - `type` 'system', required — The type of author
        - `displayName` 'Ironclad', required — The display name of the system
  - `mentionedUserDetails` object[], required — The users mentioned in the comment
    - `id` string, required — The user ID of the mentioned user
    - `displayName` string, required — The display name of the mentioned user
    - `email` string, required — The email of the mentioned user
  - `addedParticipants` string[], required — The users added to the workflow by the comment
  - `reactions` object[], required — The emoji reactions to the comment
    - `emojiId` string, required — The ID of the emoji reaction
    - `reactors` ActivityFeedAuthor[], required — The users who reacted with the particular emoji
      - union — The author of an activity feed item
        - object — An internal author of an activity feed item
          - `type` 'internalUser', required — The type of author
          - `companyName` string, required — The company name of the author
          - `displayName` string — The display name of the author
          - `email` string — The email of the author
          - `userId` string — The user ID of the author
        - object — An external author of an activity feed item (typically a counterparty)
          - `type` 'externalUser', required — The type of author
          - `companyName` string, required — The company name of the author
          - `displayName` string — The display name of the author
          - `email` string — The email of the author
        - object — An integration author of an activity feed item
          - `type` 'integration', required — The type of author
          - `displayName` string, required — The display name of the integration
        - object — A system author of an activity feed item
          - `type` 'system', required — The type of author
          - `displayName` 'Ironclad', required — The display name of the system

## Other responses

- `400` — 400

---

[API](https://skmtc.net/ironcladapp/apis/ironclad-public-api.md) · [All operations](https://skmtc.net/ironcladapp/apis/ironclad-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ironcladapp/ironclad-public-api/versions/9459b4cfc1e0/schema)