Interface CreateStoryCommentParams

Request parameters for creating a Comment on a Shortcut Story.

Hierarchy

  • CreateStoryCommentParams

Properties

author_id? blocker? created_at? external_id? parent_id? text unblocks_parent? updated_at?

Properties

Optional author_id

author_id?: string

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

Format

uuid

Optional blocker

blocker?: boolean

Marks the comment as a blocker that can be surfaced to permissions or teams mentioned in the comment. Can only be used on a top-level comment.

Optional created_at

created_at?: string

Defaults to the time/date the comment is created, but can be set to reflect another date.

Format

date-time

Optional external_id

external_id?: string

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.

Optional parent_id

parent_id?: number

The ID of the Comment that this comment is threaded under.

Format

int64

text

text: string

The comment text.

Max Length

100000

Optional unblocks_parent

unblocks_parent?: boolean

Marks the comment as an unblocker to its blocker parent. Can only be set on a threaded comment who has a parent with blocker set.

Optional updated_at

updated_at?: string

Defaults to the time/date the comment is last updated, but can be set to reflect another date.

Format

date-time

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc