Create Epic Comment

Create Epic Comment is used to add a new Comment to an Epic. To reply to an existing Comment, provide a parent_comment_id.

post/api/v4/{workspace-slug}/epics/{epic-public-id}/comments

Request

  • Base URL: https://api.app.shortcut.com
  • URL: https://api.app.shortcut.com/api/v4/{workspace-slug}/epics/{epic-public-id}/comments
  • Auth: HTTP bearer

Path parameters

workspace-slugstring required

The slug for the Workspace.

epic-public-idinteger required

The ID of the Epic.

Query parameters

fieldsstring

Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.

Request body

textstring required

The comment text.

author_idstring uuid

The Member ID of the Comment's author. Defaults to the user identified by the API token. Requires the admin role to set.

external_idstring

This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.

parent_comment_idinteger

The ID of the Comment to reply to. When provided, creates a threaded reply rather than a top-level Comment.

Response

Resource

$schemastring required

The URI for the json-schema for this response.

Changes

No recorded changes to this operation across all 1 revision of this API.