# Shortcut

Shortcut aligns product development work with company objectives so teams can execute with a shared purpose.

- **Category:** project management
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 142
- **Triggers:** 0
- **Slug:** `SHORTCUT`
- **Version:** 20260309_00

## Tools

### Create category

**Slug:** `SHORTCUT_CREATE_CATEGORY`

Create Category allows you to create a new Category in Shortcut.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the new Category. |
| `color` | string | No | The hex color to be displayed with the Category (for example, "#ff0000").  |
| `external_id` | string | No | This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create doc

**Slug:** `SHORTCUT_CREATE_DOC`

Create Doc allows you to create a new document in Shortcut. Use when you need to create documentation, notes, or any written content. Supports markdown or HTML input.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | The title for the new document. |
| `content` | string | Yes | The content for the new document. |
| `content_format` | string ("markdown" | "html") | No | Format of the content being sent. Defaults to 'html'. If 'markdown', content will be converted to HTML for storage. Storage is always HTML; this parameter just tells us what format you're sending. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create entity template

**Slug:** `SHORTCUT_CREATE_ENTITY_TEMPLATE`

Create a new entity template for the Workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the new entity template |
| `author_id` | string | No | The id of the user creating this template. |
| `story__contents__name` | string | No | The name of the story. |
| `story__contents__tasks` | array | No | An array of tasks to be populated by the template. |
| `story__contents__labels` | array | No | An array of labels to be populated by the template. |
| `story__contents__deadline` | string | No | The due date of the story. |
| `story__contents__epic__id` | integer | No | The ID of the epic the to be populated. |
| `story__contents__estimate` | integer | No | The numeric point estimate to be populated. |
| `story__contents__file__ids` | array | No | An array of the attached file IDs to be populated. |
| `story__contents__group__id` | string | No | The ID of the group to be populated. |
| `story__contents__owner__ids` | array | No | An array of UUIDs of the owners of this story. |
| `story__contents__description` | string | No | The description of the story. |
| `story__contents__project__id` | integer | No | The ID of the project the story belongs to. |
| `story__contents__story__type` | string | No | The type of story (feature, bug, chore). |
| `story__contents__follower__ids` | array | No | An array of UUIDs for any Members listed as Followers. |
| `story__contents__iteration__id` | integer | No | The ID of the iteration the to be populated. |
| `story__contents__custom__fields` | array | No | An array of maps specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.  |
| `story__contents__external__links` | array | No | An array of external links to be populated. |
| `story__contents__linked__file__ids` | array | No | An array of the linked file IDs to be populated. |
| `story__contents__workflow__state__id` | integer | No | The ID of the workflow state to be populated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create epic

**Slug:** `SHORTCUT_CREATE_EPIC`

Create Epic allows you to create a new Epic in Shortcut.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The Epic"s name. |
| `state` | string ("in progress" | "to do" | "done") | No | `Deprecated` The Epic"s state (to do, in progress, or done); will be ignored when `epic_state_id` is set.  |
| `labels` | array | No | An array of Labels attached to the Epic. |
| `deadline` | string | No | The Epic"s deadline. |
| `group_id` | string | No | `Deprecated` The ID of the group to associate with the epic. Use `group_ids`.  |
| `group_ids` | array | No | An array of UUIDS for Groups to which this Epic is related. |
| `owner_ids` | array | No | An array of UUIDs for any members you want to add as Owners on this new Epic.  |
| `created_at` | string | No | Defaults to the time/date it is created but can be set to reflect another date.  |
| `updated_at` | string | No | Defaults to the time/date it is created but can be set to reflect another date.  |
| `description` | string | No | The Epic"s description. |
| `external_id` | string | No | This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here.  |
| `follower_ids` | array | No | An array of UUIDs for any Members you want to add as Followers on this new Epic.  |
| `milestone_id` | integer | No | `Deprecated` The ID of the Milestone this Epic is related to. Use `objective_ids`.  |
| `epic_state_id` | integer | No | The ID of the Epic State. |
| `objective_ids` | array | No | An array of IDs for Objectives to which this Epic is related. |
| `requested_by_id` | string | No | The ID of the member that requested the epic. |
| `planned_start_date` | string | No | The Epic"s planned start date. |
| `started_at_override` | string | No | A manual override for the time/date the Epic was started. |
| `completed_at_override` | string | No | A manual override for the time/date the Epic was completed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create epic comment

**Slug:** `SHORTCUT_CREATE_EPIC_COMMENT`

This endpoint allows you to create a threaded Comment on an Epic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The comment text. |
| `author_id` | string | No | The Member ID of the Comment"s author. Defaults to the user identified by the API token.  |
| `created_at` | string | No | Defaults to the time/date the comment is created, but can be set to reflect another date.  |
| `updated_at` | string | No | Defaults to the time/date the comment is last updated, but can be set to reflect another date.  |
| `external_id` | string | No | 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.  |
| `epic__public__id` | integer | Yes | The ID of the associated Epic. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create epic comment comment

**Slug:** `SHORTCUT_CREATE_EPIC_COMMENT_COMMENT`

This endpoint allows you to create a nested Comment reply to an existing Epic Comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The comment text. |
| `author_id` | string | No | The Member ID of the Comment"s author. Defaults to the user identified by the API token.  |
| `created_at` | string | No | Defaults to the time/date the comment is created, but can be set to reflect another date.  |
| `updated_at` | string | No | Defaults to the time/date the comment is last updated, but can be set to reflect another date.  |
| `external_id` | string | No | 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.  |
| `epic__public__id` | integer | Yes | The ID of the associated Epic. |
| `comment__public__id` | integer | Yes | The ID of the parent Epic Comment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create epic health

**Slug:** `SHORTCUT_CREATE_EPIC_HEALTH`

Create a new health status for the specified Epic. Use when you need to set or update the health tracking status of an Epic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The description of the Health status. |
| `status` | string ("At Risk" | "On Track" | "Off Track" | "No Health") | Yes | The health status of the Epic. One of 'At Risk', 'On Track', 'Off Track', or 'No Health'. |
| `epic__public__id` | integer | Yes | The unique ID of the Epic. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create generic integration

**Slug:** `SHORTCUT_CREATE_GENERIC_INTEGRATION`

Tool to create a generic webhook integration in Shortcut. Use when you need to set up a webhook endpoint to receive Shortcut events.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secret` | string | No | Optional secret token for webhook signature verification (min 1, max 128 characters). |
| `webhook_url` | string | Yes | The webhook URL for the integration. Must be a valid HTTP or HTTPS URL (max 2048 characters). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create group

**Slug:** `SHORTCUT_CREATE_GROUP`

Creates a new group in the Shortcut system with customizable properties. This endpoint allows you to set up a group with a unique mention name, display name, optional description, and various customization options. Use this when you need to establish a new team, department, or any other collective within your Shortcut workspace. The created group can include members, associated workflows, and visual customizations like color and icon. This endpoint is particularly useful for organizing your Shortcut workspace structure, facilitating team collaboration, and streamlining workflow management. Note that while member and workflow associations can be set during creation, they can also be modified later using separate endpoints.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of this Group. |
| `color` | string | No | The color you wish to use for the Group in the system. |
| `color_key` | string ("blue" | "purple" | "midnight-blue" | "orange" | "yellow-green" | "brass" | "gray" | "fuchsia" | "yellow" | "pink" | "sky-blue" | "green" | "red" | "black" | "slate" | "turquoise") | No | The color key you wish to use for the Group in the system. |
| `member_ids` | array | No | The Member ids to add to this Group. |
| `description` | string | No | The description of the Group. |
| `mention_name` | string | Yes | The mention name of this Group. |
| `workflow_ids` | array | Yes | The Workflow ids to add to the Group. Required by the API. |
| `display_icon_id` | string | No | The Icon id for the avatar of this Group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create iteration

**Slug:** `SHORTCUT_CREATE_ITERATION`

The CreateIteration endpoint allows you to create a new Iteration in Shortcut, which represents a time-boxed period for completing a set of stories or tasks. This endpoint is crucial for teams using Agile methodologies, enabling them to plan and track progress over specific time periods. Use this endpoint when setting up sprint cycles, planning releases, or organizing work into manageable timeframes. The endpoint requires essential information such as the Iteration's name and date range, while also offering options to add followers, associate groups, and attach labels for better organization and tracking. It's important to note that while multiple groups can be added via the API, the current web UI only displays one Group association. This endpoint should not be used for modifying existing Iterations; instead, use the dedicated update endpoint for such changes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of this Iteration. |
| `labels` | array | No | An array of Labels attached to the Iteration. |
| `end_date` | string | Yes | The date this Iteration ends, e.g. 2019-07-01. |
| `group_ids` | array | No | An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI.  |
| `start_date` | string | Yes | The date this Iteration begins, e.g. 2019-07-01. |
| `description` | string | No | The description of the Iteration. |
| `follower_ids` | array | No | An array of UUIDs for any Members you want to add as Followers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create label

**Slug:** `SHORTCUT_CREATE_LABEL`

Create Label allows you to create a new Label in Shortcut.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the new Label. |
| `color` | string | No | The hex color to be displayed with the Label (for example, "#ff0000"). |
| `description` | string | No | The description of the new Label. |
| `external_id` | string | No | This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create linked file

**Slug:** `SHORTCUT_CREATE_LINKED_FILE`

Create Linked File allows you to create a new Linked File in Shortcut.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL of linked file. |
| `name` | string | Yes | The name of the file. |
| `size` | integer | No | The filesize, if the integration provided it. |
| `type` | string ("google" | "url" | "dropbox" | "box" | "onedrive") | Yes | The integration type of the file (e.g. google, dropbox, box). |
| `story_id` | integer | No | The ID of the linked story. |
| `description` | string | No | The description of the file. |
| `uploader_id` | string | No | The UUID of the member that uploaded the file. |
| `content_type` | string | No | The content type of the image (e.g. txt/plain). |
| `thumbnail_url` | string | No | The URL of the thumbnail, if the integration provided it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create milestone

**Slug:** `SHORTCUT_CREATE_MILESTONE`

(Deprecated: Use 'Create Objective') Create Milestone allows you to create a new Milestone in Shortcut.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the Milestone. |
| `state` | string ("in progress" | "to do" | "done") | No | The workflow state that the Milestone is in. |
| `categories` | array | No | An array of IDs of Categories attached to the Milestone. |
| `description` | string | No | The Milestone"s description. |
| `started_at_override` | string | No | A manual override for the time/date the Milestone was started. |
| `completed_at_override` | string | No | A manual override for the time/date the Milestone was completed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create multiple stories

**Slug:** `SHORTCUT_CREATE_MULTIPLE_STORIES`

Create Multiple Stories allows you to create multiple stories in a single request using the same syntax as [Create Story](https://developer.shortcut.com/api/rest/v3#create-story).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stories` | array | Yes | An array of stories to be created. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create objective

**Slug:** `SHORTCUT_CREATE_OBJECTIVE`

Create Objective allows you to create a new Objective in Shortcut.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the Objective. |
| `state` | string ("in progress" | "to do" | "done") | No | The workflow state that the Objective is in. |
| `categories` | array | No | An array of IDs of Categories attached to the Objective. |
| `description` | string | No | The Objective"s description. |
| `started_at_override` | string | No | A manual override for the time/date the Objective was started. |
| `completed_at_override` | string | No | A manual override for the time/date the Objective was completed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create project

**Slug:** `SHORTCUT_CREATE_PROJECT`

Create Project is used to create a new Shortcut Project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the Project. |
| `color` | string | No | The color you wish to use for the Project in the system. |
| `team_id` | integer | Yes | The ID of the team the project belongs to. |
| `created_at` | string | No | Defaults to the time/date it is created but can be set to reflect another date.  |
| `start_time` | string | No | The date at which the Project was started. |
| `updated_at` | string | No | Defaults to the time/date it is created but can be set to reflect another date.  |
| `description` | string | No | The Project description. |
| `external_id` | string | No | This field can be set to another unique ID. In the case that the Project has been imported from another tool, the ID in the other tool can be indicated here.  |
| `abbreviation` | string | No | The Project abbreviation used in Story summaries. Should be kept to 3 characters at most.  |
| `follower_ids` | array | No | An array of UUIDs for any members you want to add as Owners on this new Epic.  |
| `iteration_length` | integer | No | The number of weeks per iteration in this Project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create story

**Slug:** `SHORTCUT_CREATE_STORY`

Create Story is used to add a new story to your Shortcut Workspace. This endpoint requires that either **workflow_state_id** or **project_id** be provided, but will reject the request if both or neither are specified. The workflow_state_id has been marked as required and is the recommended field to specify because we are in the process of sunsetting Projects in Shortcut.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the story. |
| `tasks` | array | No | An array of tasks connected to the story. |
| `labels` | array | No | An array of labels attached to the story. |
| `epic_id` | integer | No | The ID of the epic the story belongs to. |
| `move_to` | string ("last" | "first") | No | One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state.  |
| `archived` | boolean | No | Controls the story"s archived state. |
| `comments` | array | No | An array of comments to add to the story. |
| `deadline` | string | No | The due date of the story. |
| `estimate` | integer | No | The numeric point estimate of the story. Can also be null, which means unestimated.  |
| `file_ids` | array | No | An array of IDs of files attached to the story. |
| `group_id` | string | No | The id of the group to associate with this story. |
| `owner_ids` | array | No | An array of UUIDs of the owners of this story. |
| `sub_tasks` | array | No | An array of sub tasks to create. |
| `created_at` | string | No | The time/date the Story was created. |
| `project_id` | integer | No | The ID of the project the story belongs to. At least one of project_id or workflow_state_id is required. |
| `story_type` | string ("feature" | "chore" | "bug") | No | The type of story (feature, bug, chore). |
| `updated_at` | string | No | The time/date the Story was updated. |
| `description` | string | No | The description of the story. |
| `external_id` | string | No | This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.  |
| `story_links` | array | No | An array of story links attached to the story. |
| `follower_ids` | array | No | An array of UUIDs of the followers of this story. |
| `iteration_id` | integer | No | The ID of the iteration the story belongs to. |
| `custom_fields` | array | No | A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.  |
| `external_links` | array | No | An array of External Links associated with this story. |
| `source_task_id` | integer | No | Given this story was converted from a task in another story, this is the original task ID that was converted to this story.  |
| `linked_file_ids` | array | No | An array of IDs of linked files attached to the story. |
| `requested_by_id` | string | No | The ID of the member that requested the story. |
| `story_template_id` | string | No | The id of the story template used to create this story, if applicable. This is just an association; no content from the story template is inherited by the story simply by setting this field.  |
| `workflow_state_id` | integer | No | The ID of the workflow state the story will be in. At least one of workflow_state_id or project_id is required. |
| `started_at_override` | string | No | A manual override for the time/date the Story was started. |
| `completed_at_override` | string | No | A manual override for the time/date the Story was completed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create story comment

**Slug:** `SHORTCUT_CREATE_STORY_COMMENT`

Create Comment allows you to create a Comment on any Story.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The comment text. |
| `author_id` | string | No | The Member ID of the Comment"s author. Defaults to the user identified by the API token.  |
| `parent_id` | integer | No | The ID of the Comment that this comment is threaded under. |
| `created_at` | string | No | Defaults to the time/date the comment is created, but can be set to reflect another date.  |
| `updated_at` | string | No | Defaults to the time/date the comment is last updated, but can be set to reflect another date.  |
| `external_id` | string | No | 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.  |
| `story__public__id` | integer | Yes | The ID of the Story that the Comment is in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create story from template

**Slug:** `SHORTCUT_CREATE_STORY_FROM_TEMPLATE`

Create Story From Template is used to add a new story derived from a template to your Shortcut Workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the story. Must be provided if the template does not provide a name.  |
| `tasks` | array | No | An array of tasks connected to the story. |
| `labels` | array | No | An array of labels attached to the story. |
| `epic_id` | integer | No | The ID of the epic the story belongs to. |
| `move_to` | string ("last" | "first") | No | One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state.  |
| `archived` | boolean | No | Controls the story"s archived state. |
| `comments` | array | No | An array of comments to add to the story. |
| `deadline` | string | No | The due date of the story. |
| `estimate` | integer | No | The numeric point estimate of the story. Can also be null, which means unestimated.  |
| `file_ids` | array | No | An array of IDs of files attached to the story. |
| `group_id` | string | No | The id of the group to associate with this story. |
| `owner_ids` | array | No | An array of UUIDs of the owners of this story. |
| `sub_tasks` | array | No | An array of sub tasks to create. |
| `created_at` | string | No | The time/date the Story was created. |
| `labels_add` | array | No | An array of labels attached to the story in addition to the labels provided by the template. Cannot be used in conjunction with `labels`.  |
| `project_id` | integer | No | The ID of the project the story belongs to. |
| `story_type` | string ("feature" | "chore" | "bug") | No | The type of story (feature, bug, chore). |
| `updated_at` | string | No | The time/date the Story was updated. |
| `description` | string | No | The description of the story. |
| `external_id` | string | No | This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.  |
| `story_links` | array | No | An array of story links attached to the story. |
| `file_ids_add` | array | No | An array of IDs of files attached to the story in addition to files from the template. Cannot be used in conjunction with `file_ids`.  |
| `follower_ids` | array | No | An array of UUIDs of the followers of this story. |
| `iteration_id` | integer | No | The ID of the iteration the story belongs to. |
| `custom_fields` | array | No | A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.  |
| `labels_remove` | array | No | An array of labels to remove from the labels provided by the template. Cannot be used in conjunction with `labels`.  |
| `owner_ids_add` | array | No | The UUIDs of the new owners to be added in addition to owners from the template. Cannot be used in conjunction with `owners`.  |
| `external_links` | array | No | An array of External Links associated with this story. |
| `source_task_id` | integer | No | Given this story was converted from a task in another story, this is the original task ID that was converted to this story.  |
| `file_ids_remove` | array | No | An array of IDs of files removed from files from the template. Cannot be used in conjunction with `file_ids`.  |
| `linked_file_ids` | array | No | An array of IDs of linked files attached to the story. |
| `requested_by_id` | string | No | The ID of the member that requested the story. |
| `follower_ids_add` | array | No | The UUIDs of the new followers to be added in addition to followers from the template. Cannot be used in conjunction with `follower_ids.`  |
| `owner_ids_remove` | array | No | The UUIDs of the new owners to be removed from owners from the template. Cannot be used in conjunction with `owners`.  |
| `custom_fields_add` | array | No | A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. These will be added to any fields provided by the template. Cannot be used in conjunction with `custom_fields`.  |
| `story_template_id` | string | Yes | The id of the story template used to create this story. |
| `workflow_state_id` | integer | No | The ID of the workflow state the story will be in. |
| `external_links_add` | array | No | An array of External Links associated with this story. These will be added to any links provided by the template. Cannot be used in conjunction with `external_links`.  |
| `follower_ids_remove` | array | No | The UUIDs of the new followers to be removed from followers from the template. Cannot be used in conjunction with `follower_ids`.  |
| `linked_file_ids_add` | array | No | An array of IDs of linked files attached to the story in addition to files from the template. Cannot be used in conjunction with `linked_files`.  |
| `started_at_override` | string | No | A manual override for the time/date the Story was started. |
| `custom_fields_remove` | array | No | A map specifying a CustomField ID. These will be removed from any fields provided by the template. Cannot be used in conjunction with `custom_fields`.  |
| `completed_at_override` | string | No | A manual override for the time/date the Story was completed. |
| `external_links_remove` | array | No | An array of External Links associated with this story. These will be removed from any links provided by the template. Cannot be used in conjunction with `external_links`.  |
| `linked_file_ids_remove` | array | No | An array of IDs of linked files removed from files from the template. Cannot be used in conjunction with `linked_files.`  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create story link

**Slug:** `SHORTCUT_CREATE_STORY_LINK`

Story Links (called Story Relationships in the UI) allow you create semantic relationships between two stories. The parameters read like an active voice grammatical sentence: subject -> verb -> object. The subject story acts on the object Story; the object story is the direct object of the sentence. The subject story "blocks", "duplicates", or "relates to" the object story. Examples: - "story 5 blocks story 6” -- story 6 is now "blocked" until story 5 is moved to a Done workflow state. - "story 2 duplicates story 1” -- Story 2 represents the same body of work as Story 1 (and should probably be archived). - "story 7 relates to story 3”

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `verb` | string ("blocks" | "duplicates" | "relates to") | Yes | The type of link. |
| `object_id` | integer | Yes | The ID of the object Story. |
| `subject_id` | integer | Yes | The ID of the subject Story. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create story reaction

**Slug:** `SHORTCUT_CREATE_STORY_REACTION`

Create a reaction to a story comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emoji` | string | Yes | The emoji short-code to add / remove. E.g. `:thumbsup::skin-tone-4:`. |
| `story__public__id` | integer | Yes | The ID of the Story that the Comment is in. |
| `comment__public__id` | integer | Yes | The ID of the Comment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create task

**Slug:** `SHORTCUT_CREATE_TASK`

Create Task is used to create a new task in a Story.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `complete` | boolean | No | True/false boolean indicating whether the Task is completed. Defaults to false.  |
| `owner_ids` | array | No | An array of UUIDs for any members you want to add as Owners on this new Task.  |
| `created_at` | string | No | Defaults to the time/date the Task is created but can be set to reflect another creation time/date.  |
| `updated_at` | string | No | Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date.  |
| `description` | string | Yes | The Task description. |
| `external_id` | string | No | This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here.  |
| `story__public__id` | integer | Yes | The ID of the Story that the Task will be in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete category

**Slug:** `SHORTCUT_DELETE_CATEGORY`

Delete Category can be used to delete any Category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category__public__id` | integer | Yes | The unique ID of the Category. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete custom field

**Slug:** `SHORTCUT_DELETE_CUSTOM_FIELD`

Deletes a specific custom field from the Shortcut system using its unique public identifier. This endpoint should be used when you need to permanently remove a custom field that is no longer required in your workflows or project structure. It's important to note that this operation is irreversible, and once a custom field is deleted, all data associated with it will be lost. Use this endpoint with caution, ensuring that the custom field is no longer needed and that its deletion won't negatively impact any existing processes or data integrity within your Shortcut instance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom__field__public__id` | string | Yes | The unique ID of the CustomField. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete doc

**Slug:** `SHORTCUT_DELETE_DOC`

Permanently deletes a Doc and its associated data from Shortcut. Requires admin access to the document. When a document is deleted, connected clients will be notified via Server-Sent Events (SSE). Use this action when you need to remove a document completely from the system. Be cautious as this operation is irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `doc__public__id` | string | Yes | The Doc's public ID (UUID format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | null | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete entity template

**Slug:** `SHORTCUT_DELETE_ENTITY_TEMPLATE`

Deletes a specific entity template from the Shortcut API. This endpoint should be used when you need to permanently remove a template that is no longer needed or is obsolete. It's important to note that this operation cannot be undone, so it should be used with caution. The deletion is performed on a single template identified by its public ID, adhering to the best practice of controlling deletion on a per-resource basis. This endpoint is part of the API v3, which may include enhanced features or changes compared to previous versions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity__template__public__id` | string | Yes | The unique ID of the entity template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete epic

**Slug:** `SHORTCUT_DELETE_EPIC`

Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic__public__id` | integer | Yes | The unique ID of the Epic. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | null | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete epic comment

**Slug:** `SHORTCUT_DELETE_EPIC_COMMENT`

This endpoint allows you to delete a Comment from an Epic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic__public__id` | integer | Yes | The ID of the associated Epic. |
| `comment__public__id` | integer | Yes | The ID of the Comment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete file

**Slug:** `SHORTCUT_DELETE_FILE`

Delete File deletes a previously uploaded file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file__public__id` | integer | Yes | The File’s unique ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete generic integration

**Slug:** `SHORTCUT_DELETE_GENERIC_INTEGRATION`

Tool to delete a generic webhook integration from Shortcut. Use when you need to permanently remove a webhook integration that is no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `integration__public__id` | integer | Yes | The unique ID of the Generic Integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete iteration

**Slug:** `SHORTCUT_DELETE_ITERATION`

Deletes a specific iteration from the Shortcut project management system. This endpoint should be used when you need to permanently remove an iteration and all its associated data from your project workflow. It's particularly useful for cleaning up completed or cancelled iterations that are no longer needed. Be cautious when using this endpoint, as the deletion is irreversible and will remove all data associated with the specified iteration. Ensure you have the correct iteration ID before proceeding with the deletion to avoid unintended data loss.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `iteration__public__id` | integer | Yes | The unique ID of the Iteration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete label

**Slug:** `SHORTCUT_DELETE_LABEL`

Delete Label can be used to delete any Label.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label__public__id` | integer | Yes | The unique ID of the Label. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete linked file

**Slug:** `SHORTCUT_DELETE_LINKED_FILE`

Delete Linked File can be used to delete any previously attached Linked-File.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `linked__file__public__id` | integer | Yes | The unique identifier of the linked file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete milestone

**Slug:** `SHORTCUT_DELETE_MILESTONE`

(Deprecated: Use 'Delete Objective') Delete Milestone can be used to delete any Milestone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `milestone__public__id` | integer | Yes | The ID of the Milestone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete multiple stories

**Slug:** `SHORTCUT_DELETE_MULTIPLE_STORIES`

Delete Multiple Stories allows you to delete multiple archived stories at once.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `story_ids` | array | Yes | An array of IDs of Stories to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete objective

**Slug:** `SHORTCUT_DELETE_OBJECTIVE`

Delete Objective can be used to delete any Objective.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `objective__public__id` | integer | Yes | The ID of the Objective. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete project

**Slug:** `SHORTCUT_DELETE_PROJECT`

Delete Project can be used to delete a Project. Projects can only be deleted if all associated Stories are moved or deleted. In the case that the Project cannot be deleted, you will receive a 422 response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project__public__id` | integer | Yes | The unique ID of the Project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete story

**Slug:** `SHORTCUT_DELETE_STORY`

Delete Story can be used to delete any Story.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `story__public__id` | integer | Yes | The ID of the Story. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete story comment

**Slug:** `SHORTCUT_DELETE_STORY_COMMENT`

Delete a Comment from any story.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `story__public__id` | integer | Yes | The ID of the Story that the Comment is in. |
| `comment__public__id` | integer | Yes | The ID of the Comment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete story link

**Slug:** `SHORTCUT_DELETE_STORY_LINK`

Removes the relationship between the stories for the given Story Link.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `story__link__public__id` | integer | Yes | The unique ID of the Story Link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete story reaction

**Slug:** `SHORTCUT_DELETE_STORY_REACTION`

Delete a reaction from any story comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emoji` | string | Yes | The emoji short-code to add / remove. E.g. `:thumbsup::skin-tone-4:`. |
| `story__public__id` | integer | Yes | The ID of the Story that the Comment is in. |
| `comment__public__id` | integer | Yes | The ID of the Comment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete task

**Slug:** `SHORTCUT_DELETE_TASK`

Delete Task can be used to delete any previously created Task on a Story.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task__public__id` | integer | Yes | The unique ID of the Task. |
| `story__public__id` | integer | Yes | The unique ID of the Story this Task is associated with. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable iterations

**Slug:** `SHORTCUT_DISABLE_ITERATIONS`

Disables Iterations for the current workspace

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable story templates

**Slug:** `SHORTCUT_DISABLE_STORY_TEMPLATES`

Disables the Story Template feature for the Workspace.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable iterations

**Slug:** `SHORTCUT_ENABLE_ITERATIONS`

Enables Iterations for the current workspace

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable story templates

**Slug:** `SHORTCUT_ENABLE_STORY_TEMPLATES`

Enables the Story Template feature for the Workspace.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get category

**Slug:** `SHORTCUT_GET_CATEGORY`

Get Category returns information about the selected Category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category__public__id` | integer | Yes | The unique ID of the Category. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get current member info

**Slug:** `SHORTCUT_GET_CURRENT_MEMBER_INFO`

Returns information about the authenticated member.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get custom field

**Slug:** `SHORTCUT_GET_CUSTOM_FIELD`

Retrieves detailed information about a specific custom field in Shortcut using its unique public identifier. This endpoint allows developers to fetch the properties and configuration of a custom field, which can include its name, type, possible values, and any other associated metadata. It's particularly useful when you need to inspect or validate a custom field's settings programmatically, or when integrating custom field data into external systems. The endpoint should be used when detailed information about a single custom field is required, rather than for bulk operations or listing all custom fields. Note that this endpoint only provides read access to custom field data and cannot be used to modify the custom field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom__field__public__id` | string | Yes | The unique ID of the CustomField. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get doc

**Slug:** `SHORTCUT_GET_DOC`

Get Doc returns information about a chosen Doc by its public ID. Use content_format=html to include HTML content in the response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content__format` | string ("markdown" | "html") | No | Format of the content to return. |
| `doc__public__id` | string | Yes | The Doc's public ID (UUID format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get entity template

**Slug:** `SHORTCUT_GET_ENTITY_TEMPLATE`

Get Entity Template returns information about a given entity template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity__template__public__id` | string | Yes | The unique ID of the entity template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get epic

**Slug:** `SHORTCUT_GET_EPIC`

Get Epic returns information about the selected Epic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic__public__id` | integer | Yes | The unique ID of the Epic. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get epic comment

**Slug:** `SHORTCUT_GET_EPIC_COMMENT`

This endpoint returns information about the selected Epic Comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic__public__id` | integer | Yes | The ID of the associated Epic. |
| `comment__public__id` | integer | Yes | The ID of the Comment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get epic health

**Slug:** `SHORTCUT_GET_EPIC_HEALTH`

Get the current health status for the specified Epic. Use when you need to check the health status of an Epic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic__public__id` | integer | Yes | The unique ID of the Epic. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get epic workflow

**Slug:** `SHORTCUT_GET_EPIC_WORKFLOW`

Returns the Epic Workflow for the Workspace.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get external link stories

**Slug:** `SHORTCUT_GET_EXTERNAL_LINK_STORIES`

Get Stories which have a given External Link associated with them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `external_link` | string | Yes | The external link associated with one or more stories. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get file

**Slug:** `SHORTCUT_GET_FILE`

Get File returns information about the selected UploadedFile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file__public__id` | integer | Yes | The File’s unique ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get generic integration

**Slug:** `SHORTCUT_GET_GENERIC_INTEGRATION`

Get Generic Integration returns information about a webhook integration by its ID. Use when you need to retrieve details about a specific webhook integration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `integration__public__id` | integer | Yes | The unique ID of the Generic Integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get group

**Slug:** `SHORTCUT_GET_GROUP`

Retrieves detailed information about a specific group in the Shortcut workspace using its unique public identifier. This endpoint allows developers to fetch comprehensive data about a group, including its name, type, and associated metadata. It's particularly useful when you need to access or verify group details programmatically, such as during workflow automations or when building integrations that involve group management. The endpoint provides more granular control and information compared to what's available through the web application, making it valuable for advanced group-related operations and data analysis within your Shortcut projects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group__public__id` | string | Yes | The unique ID of the Group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get iteration

**Slug:** `SHORTCUT_GET_ITERATION`

Retrieves detailed information about a specific iteration in the Shortcut project management system. This endpoint allows users to fetch comprehensive data about a single iteration, including its name, status, start and end dates, associated stories, and progress metrics. It should be used when detailed information about a particular iteration is needed, such as during sprint planning, progress tracking, or retrospective analysis. The endpoint provides a snapshot of the iteration at the time of the request and does not include real-time updates. It's particularly useful for project managers, scrum masters, and team members who need to review or report on iteration-specific data. Note that this endpoint only retrieves information and does not allow for modification of the iteration details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `iteration__public__id` | integer | Yes | The unique ID of the Iteration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get key result

**Slug:** `SHORTCUT_GET_KEY_RESULT`

Get Key Result returns information about a chosen Key Result.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key__result__public__id` | string | Yes | The ID of the Key Result. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get label

**Slug:** `SHORTCUT_GET_LABEL`

Get Label returns information about the selected Label.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label__public__id` | integer | Yes | The unique ID of the Label. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get linked file

**Slug:** `SHORTCUT_GET_LINKED_FILE`

Get File returns information about the selected Linked File.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `linked__file__public__id` | integer | Yes | The unique identifier of the linked file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get member

**Slug:** `SHORTCUT_GET_MEMBER`

Returns information about a Member.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org__public__id` | string | No | The unique ID of the Organization to limit the lookup to. |
| `member__public__id` | string | Yes | The Member"s unique ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get milestone

**Slug:** `SHORTCUT_GET_MILESTONE`

(Deprecated: Use 'Get Objective') Get Milestone returns information about a chosen Milestone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `milestone__public__id` | integer | Yes | The ID of the Milestone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get objective

**Slug:** `SHORTCUT_GET_OBJECTIVE`

Get Objective returns information about a chosen Objective.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `objective__public__id` | integer | Yes | The ID of the Objective. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get project

**Slug:** `SHORTCUT_GET_PROJECT`

Get Project returns information about the selected Project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project__public__id` | integer | Yes | The unique ID of the Project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get repository

**Slug:** `SHORTCUT_GET_REPOSITORY`

Get Repository returns information about the selected Repository.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `repo__public__id` | integer | Yes | The unique ID of the Repository. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get story

**Slug:** `SHORTCUT_GET_STORY`

Get Story returns information about a chosen Story.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `story__public__id` | integer | Yes | The ID of the Story. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get story comment

**Slug:** `SHORTCUT_GET_STORY_COMMENT`

Get Comment is used to get Comment information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `story__public__id` | integer | Yes | The ID of the Story that the Comment is in. |
| `comment__public__id` | integer | Yes | The ID of the Comment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get story link

**Slug:** `SHORTCUT_GET_STORY_LINK`

Returns the stories and their relationship for the given Story Link.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `story__link__public__id` | integer | Yes | The unique ID of the Story Link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get task

**Slug:** `SHORTCUT_GET_TASK`

Returns information about a chosen Task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task__public__id` | integer | Yes | The unique ID of the Task. |
| `story__public__id` | integer | Yes | The unique ID of the Story this Task is associated with. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get workflow

**Slug:** `SHORTCUT_GET_WORKFLOW`

Get Workflow returns information about a chosen Workflow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow__public__id` | integer | Yes | The ID of the Workflow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Link document to epic

**Slug:** `SHORTCUT_LINK_DOCUMENT_TO_EPIC`

Tool to create a relationship between a Document and an Epic. Use when you need to link or associate documentation with an epic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `doc__public__id` | string | Yes | The public ID of the Document. |
| `epic__public__id` | integer | Yes | The public ID of the Epic. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | null | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List categories

**Slug:** `SHORTCUT_LIST_CATEGORIES`

List Categories returns a list of all Categories and their attributes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List category milestones

**Slug:** `SHORTCUT_LIST_CATEGORY_MILESTONES`

List Category Milestones returns a list of all Milestones with the Category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category__public__id` | integer | Yes | The unique ID of the Category. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List category objectives

**Slug:** `SHORTCUT_LIST_CATEGORY_OBJECTIVES`

Returns a list of all Objectives with the Category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category__public__id` | integer | Yes | The unique ID of the Category. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List custom fields

**Slug:** `SHORTCUT_LIST_CUSTOM_FIELDS`

Retrieves a list of all custom fields defined in the Shortcut API. This endpoint allows developers to fetch information about user-defined fields that have been added to extend the functionality of standard fields in integrations. It's particularly useful when you need to understand the structure and types of custom data being used across the system. The endpoint returns details about each custom field, which may include their identifiers, names, types, and any associated metadata. Use this endpoint when you need to inventory existing custom fields, prepare for data migrations, or dynamically adjust your application's data model to accommodate custom fields. Note that this endpoint does not create, modify, or delete custom fields; it's purely for retrieval of existing custom field definitions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List docs

**Slug:** `SHORTCUT_LIST_DOCS`

Tool to list Docs that the current user can read. Use when you need to retrieve all accessible documentation in the Shortcut workspace.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List document epics

**Slug:** `SHORTCUT_LIST_DOCUMENT_EPICS`

Tool to retrieve all Epics related to a specific Document. Use when you need to understand which Epics are associated with a given document in Shortcut.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `doc__public__id` | string | Yes | The public ID of the Document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List entity templates

**Slug:** `SHORTCUT_LIST_ENTITY_TEMPLATES`

List all the entity templates for the Workspace.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List epic comments

**Slug:** `SHORTCUT_LIST_EPIC_COMMENTS`

Get a list of all Comments on an Epic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic__public__id` | integer | Yes | The unique ID of the Epic. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List epic documents

**Slug:** `SHORTCUT_LIST_EPIC_DOCUMENTS`

Get a list of all Documents related to this Epic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic__public__id` | integer | Yes | The unique ID of the Epic. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List epic healths

**Slug:** `SHORTCUT_LIST_EPIC_HEALTHS`

List the history of health statuses for the specified Epic, most recent first. Use when you need to track health status changes over time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic__public__id` | integer | Yes | The unique ID of the Epic. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List epics

**Slug:** `SHORTCUT_LIST_EPICS`

List Epics returns a list of all Epics and their attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `includes_description` | boolean | No | A true/false boolean indicating whether to return Epics with their descriptions.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List epics paginated

**Slug:** `SHORTCUT_LIST_EPICS_PAGINATED`

List Epics with pagination returns a paginated list of Epics and their attributes. Use when you need to retrieve Epics in manageable pages rather than all at once.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number to return, starting with 1. Defaults to 1. |
| `page_size` | integer | No | The number of Epics to return per page. Minimum 1, maximum 250, default 10. |
| `includes_description` | boolean | No | A true/false boolean indicating whether to return Epics with their descriptions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List epic stories

**Slug:** `SHORTCUT_LIST_EPIC_STORIES`

Get a list of all Stories in an Epic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic__public__id` | integer | Yes | The unique ID of the Epic. |
| `includes_description` | boolean | No | A true/false boolean indicating whether to return Stories with their descriptions.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List files

**Slug:** `SHORTCUT_LIST_FILES`

List Files returns a list of all UploadedFiles in the workspace.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List groups

**Slug:** `SHORTCUT_LIST_GROUPS`

A group in our API maps to a "Team" within the Shortcut Product. A Team is a collection of Users that can be associated to Stories, Epics, and Iterations within Shortcut.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List group stories

**Slug:** `SHORTCUT_LIST_GROUP_STORIES`

List the Stories assigned to the Group. (By default, limited to 1,000).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | The maximum number of results to return. (Defaults to 1000, max 1000) |
| `offset` | integer | No | The offset at which to begin returning results. (Defaults to 0) |
| `group__public__id` | string | Yes | The unique ID of the Group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List iterations

**Slug:** `SHORTCUT_LIST_ITERATIONS`

Retrieves a list of all iterations in the Shortcut project management system. Iterations represent specific time periods for planning and tracking work, allowing teams to organize their development cycles. This endpoint provides comprehensive information about each iteration, including its name, start and end dates, status, and associated stories or tasks. Use this endpoint when you need an overview of all iterations for project planning, progress tracking, or reporting purposes. It's particularly useful for analyzing past performance, planning future sprints, or getting a high-level view of the project timeline. Note that the response may be paginated for projects with a large number of iterations, and you might need to make multiple requests to retrieve the full dataset.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List iteration stories

**Slug:** `SHORTCUT_LIST_ITERATION_STORIES`

Get a list of all Stories in an Iteration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `includes_description` | boolean | No | A true/false boolean indicating whether to return Stories with their descriptions.  |
| `iteration__public__id` | integer | Yes | The unique ID of the Iteration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List label epics

**Slug:** `SHORTCUT_LIST_LABEL_EPICS`

List all of the Epics with the Label.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label__public__id` | integer | Yes | The unique ID of the Label. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List labels

**Slug:** `SHORTCUT_LIST_LABELS`

List Labels returns a list of all Labels and their attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `slim` | boolean | No | A true/false boolean indicating if the slim versions of the Label should be returned.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List label stories

**Slug:** `SHORTCUT_LIST_LABEL_STORIES`

List all of the Stories with the Label.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label__public__id` | integer | Yes | The unique ID of the Label. |
| `includes_description` | boolean | No | A true/false boolean indicating whether to return Stories with their descriptions.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List linked files

**Slug:** `SHORTCUT_LIST_LINKED_FILES`

List Linked Files returns a list of all Linked-Files and their attributes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List members

**Slug:** `SHORTCUT_LIST_MEMBERS`

Returns information about members of the Workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org__public__id` | string | No | The unique ID of the Organization to limit the list to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List members (slim)

**Slug:** `SHORTCUT_LIST_MEMBERS_SLIM`

Returns minimal member data optimized for Korey integration. Use this when you need basic member information without full profile details. Returns all workspace members with disabled status indicated in the response.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List milestone epics

**Slug:** `SHORTCUT_LIST_MILESTONE_EPICS`

(Deprecated: Use 'List Objective Epics') List all of the Epics within the Milestone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `milestone__public__id` | integer | Yes | The ID of the Milestone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List milestones

**Slug:** `SHORTCUT_LIST_MILESTONES`

(Deprecated: Use 'List Objectives') List Milestones returns a list of all Milestones and their attributes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List objective epics

**Slug:** `SHORTCUT_LIST_OBJECTIVE_EPICS`

List all of the Epics within the Objective.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `objective__public__id` | integer | Yes | The ID of the Objective. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List objectives

**Slug:** `SHORTCUT_LIST_OBJECTIVES`

List Objectives returns a list of all Objectives and their attributes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List projects

**Slug:** `SHORTCUT_LIST_PROJECTS`

List Projects returns a list of all Projects and their attributes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List repositories

**Slug:** `SHORTCUT_LIST_REPOSITORIES`

List Repositories returns a list of all Repositories and their attributes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List stories

**Slug:** `SHORTCUT_LIST_STORIES`

List Stories returns a list of all Stories in a selected Project and their attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project__public__id` | integer | Yes | The unique ID of the Project. |
| `includes_description` | boolean | No | A true/false boolean indicating whether to return Stories with their descriptions.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List story comment

**Slug:** `SHORTCUT_LIST_STORY_COMMENT`

Lists Comments associated with a Story

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `story__public__id` | integer | Yes | The ID of the Story that the Comment is in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List story sub-tasks

**Slug:** `SHORTCUT_LIST_STORY_SUB_TASKS`

Tool to list all Sub-task Stories for a given parent Story. Use when you need to retrieve all sub-tasks associated with a specific story.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `story__public__id` | integer | Yes | The ID of the Story. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List workflows

**Slug:** `SHORTCUT_LIST_WORKFLOWS`

Returns a list of all Workflows in the Workspace.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search

**Slug:** `SHORTCUT_SEARCH`

Search lets you search Epics and Stories based on desired parameters. Since ordering of the results can change over time (due to search ranking decay, new Epics and Stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | The next page token. |
| `query` | string | Yes | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)  |
| `detail` | string ("full" | "slim") | No | The amount of detail included in each result item.    "full" will include all descriptions and comments and more fields on    related items such as pull requests, branches and tasks.    "slim" omits larger fulltext fields such as descriptions and comments    and only references related items by id.    The default is "full".  |
| `page_size` | integer | No | The number of search results to include in a page. Minimum of 1 and maximum of 25.  |
| `entity_types` | array | No | A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search documents

**Slug:** `SHORTCUT_SEARCH_DOCUMENTS`

Tool to search Documents based on title and filters. Use when you need to find specific documents by fuzzy title matching or filter by archived/created_by_me/followed_by_me status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | The next page token. |
| `title` | string | Yes | Search text to match against document titles. Supports fuzzy matching. Required. |
| `archived` | boolean | No | When true, find archived documents. When false, find non-archived documents. |
| `page_size` | integer | No | The number of search results to include in a page. Minimum of 1 and maximum of 250. |
| `created_by_me` | boolean | No | When true, find documents created by the current user. When false, find documents NOT created by current user. |
| `followed_by_me` | boolean | No | When true, find documents that the current user is following. When false, find documents NOT followed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search epics

**Slug:** `SHORTCUT_SEARCH_EPICS`

Search Epics lets you search Epics based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new Epics being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | The next page token. |
| `query` | string | Yes | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)  |
| `detail` | string ("full" | "slim") | No | The amount of detail included in each result item.    "full" will include all descriptions and comments and more fields on    related items such as pull requests, branches and tasks.    "slim" omits larger fulltext fields such as descriptions and comments    and only references related items by id.    The default is "full".  |
| `page_size` | integer | No | The number of search results to include in a page. Minimum of 1 and maximum of 25.  |
| `entity_types` | array | No | A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search iterations

**Slug:** `SHORTCUT_SEARCH_ITERATIONS`

Search Iterations lets you search Iterations based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Iterations being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | The next page token. |
| `query` | string | Yes | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)  |
| `detail` | string ("full" | "slim") | No | The amount of detail included in each result item.    "full" will include all descriptions and comments and more fields on    related items such as pull requests, branches and tasks.    "slim" omits larger fulltext fields such as descriptions and comments    and only references related items by id.    The default is "full".  |
| `page_size` | integer | No | The number of search results to include in a page. Minimum of 1 and maximum of 25.  |
| `entity_types` | array | No | A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search milestones

**Slug:** `SHORTCUT_SEARCH_MILESTONES`

Search Milestones lets you search Milestones based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Milestones being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | The next page token. |
| `query` | string | Yes | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)  |
| `detail` | string ("full" | "slim") | No | The amount of detail included in each result item.    "full" will include all descriptions and comments and more fields on    related items such as pull requests, branches and tasks.    "slim" omits larger fulltext fields such as descriptions and comments    and only references related items by id.    The default is "full".  |
| `page_size` | integer | No | The number of search results to include in a page. Minimum of 1 and maximum of 25.  |
| `entity_types` | array | No | A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search objectives

**Slug:** `SHORTCUT_SEARCH_OBJECTIVES`

Search Objectives lets you search Objectives based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Objectives being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | The next page token. |
| `query` | string | Yes | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)  |
| `detail` | string ("full" | "slim") | No | The amount of detail included in each result item.    "full" will include all descriptions and comments and more fields on    related items such as pull requests, branches and tasks.    "slim" omits larger fulltext fields such as descriptions and comments    and only references related items by id.    The default is "full".  |
| `page_size` | integer | No | The number of search results to include in a page. Minimum of 1 and maximum of 25.  |
| `entity_types` | array | No | A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search stories

**Slug:** `SHORTCUT_SEARCH_STORIES`

Search Stories lets you search Stories based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | The next page token. |
| `query` | string | Yes | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)  |
| `detail` | string ("full" | "slim") | No | The amount of detail included in each result item.    "full" will include all descriptions and comments and more fields on    related items such as pull requests, branches and tasks.    "slim" omits larger fulltext fields such as descriptions and comments    and only references related items by id.    The default is "full".  |
| `page_size` | integer | No | The number of search results to include in a page. Minimum of 1 and maximum of 25.  |
| `entity_types` | array | No | A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search stories old

**Slug:** `SHORTCUT_SEARCH_STORIES_OLD`

Search Stories lets you search Stories based on desired parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic_id` | integer | No | The Epic IDs that may be associated with the Stories. |
| `archived` | boolean | No | A true/false boolean indicating whether the Story is in archived state. |
| `epic_ids` | array | No | The Epic IDs that may be associated with the Stories. |
| `estimate` | integer | No | The number of estimate points associate with the Stories. |
| `group_id` | string | No | The Group ID that is associated with the Stories |
| `owner_id` | string | No | An array of UUIDs for any Users who may be Owners of the Stories. |
| `group_ids` | array | No | The Group IDs that are associated with the Stories |
| `label_ids` | array | No | The Label IDs that may be associated with the Stories. |
| `owner_ids` | array | No | An array of UUIDs for any Users who may be Owners of the Stories. |
| `label_name` | string | No | The name of any associated Labels. |
| `project_id` | integer | No | The IDs for the Projects the Stories may be assigned to. |
| `story_type` | string ("feature" | "chore" | "bug") | No | The type of Stories that you want returned. |
| `external_id` | string | No | An ID or URL that references an external resource. Useful during imports.  |
| `project_ids` | array | No | The IDs for the Projects the Stories may be assigned to. |
| `deadline_end` | string | No | Stories should have a deadline on or before this date. |
| `iteration_id` | integer | No | The Iteration ID that may be associated with the Stories. |
| `iteration_ids` | array | No | The Iteration IDs that may be associated with the Stories. |
| `created_at_end` | string | No | Stories should have been created on or before this date. |
| `deadline_start` | string | No | Stories should have a deadline on or after this date. |
| `updated_at_end` | string | No | Stories should have been updated on or before this date. |
| `requested_by_id` | string | No | The UUID of any Users who may have requested the Stories. |
| `completed_at_end` | string | No | Stories should have been completed on or before this date. |
| `created_at_start` | string | No | Stories should have been created on or after this date. |
| `updated_at_start` | string | No | Stories should have been updated on or after this date. |
| `workflow_state_id` | integer | No | The unique IDs of the specific Workflow States that the Stories should be in.  |
| `completed_at_start` | string | No | Stories should have been completed on or after this date. |
| `includes_description` | boolean | No | Whether to include the story description in the response. |
| `workflow_state_types` | array | No | The type of Workflow State the Stories may be in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Story history

**Slug:** `SHORTCUT_STORY_HISTORY`

Retrieves the complete history of changes for a specific story in the Shortcut project management system. This endpoint allows users to track all modifications, updates, and revisions made to a story over time, providing a comprehensive timeline of its evolution. It's particularly useful for project managers, team members, and stakeholders who need to understand how a story has changed, who made the changes, and when they occurred. The endpoint returns a chronological list of all events and modifications associated with the specified story, helping teams maintain transparency and accountability in their project workflows. Note that this endpoint focuses solely on the history of a single story and does not provide information about related stories or overall project status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `story__public__id` | integer | Yes | The ID of the Story. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unlink comment thread from slack

**Slug:** `SHORTCUT_UNLINK_COMMENT_THREAD_FROM_SLACK`

Unlinks a Comment from its linked Slack thread (Comment replies and Slack replies will no longer be synced)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `story__public__id` | integer | Yes | The ID of the Story to unlink. |
| `comment__public__id` | integer | Yes | The ID of the Comment to unlink. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unlink document from epic

**Slug:** `SHORTCUT_UNLINK_DOCUMENT_FROM_EPIC`

Tool to remove the relationship between a Document and an Epic. Use when you need to unlink a previously associated document from an epic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `doc__public__id` | string | Yes | The public ID of the Document. |
| `epic__public__id` | integer | Yes | The public ID of the Epic. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unlink productboard from epic

**Slug:** `SHORTCUT_UNLINK_PRODUCTBOARD_FROM_EPIC`

This endpoint allows you to unlink a productboard epic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic__public__id` | integer | Yes | The unique ID of the Epic. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update category

**Slug:** `SHORTCUT_UPDATE_CATEGORY`

Update Category allows you to replace a Category name with another name. If you try to name a Category something that already exists, you will receive a 422 response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The new name of the Category. |
| `color` | string | No | The hex color to be displayed with the Category (for example, "#ff0000").  |
| `archived` | boolean | No | A true/false boolean indicating if the Category has been archived. |
| `category__public__id` | integer | Yes | The unique ID of the Category you wish to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update custom field

**Slug:** `SHORTCUT_UPDATE_CUSTOM_FIELD`

Update Custom Field can be used to update the definition of a Custom Field. The order of items in the 'values' collection is interpreted to be their ascending sort order.To delete an existing enum value, simply omit it from the 'values' collection. New enum values may be created inline by including an object in the 'values' collection having a 'value' entry with no 'id' (eg. {'value': 'myNewValue', 'color_key': 'green'}).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | A collection of objects representing reporting periods for years. |
| `values` | array | No | A collection of EnumValue objects representing the values in the domain of some Custom Field.  |
| `enabled` | boolean | No | Indicates whether the Field is enabled for the Workspace. Only enabled fields can be applied to Stories.  |
| `after_id` | string | No | The ID of the CustomField we want to move this CustomField after. |
| `before_id` | string | No | The ID of the CustomField we want to move this CustomField before. |
| `description` | string | No | A description of the purpose of this field. |
| `icon_set_identifier` | string | No | A frontend-controlled string that represents the icon for this custom field.  |
| `custom__field__public__id` | string | Yes | The unique ID of the CustomField. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Doc

**Slug:** `SHORTCUT_UPDATE_DOC`

Tool to update an existing Doc's title and/or content. Use when you need to modify document properties. Supports markdown or HTML input via content_format parameter. SSE events notify connected users to refresh; if no users are connected, CKEditor cache is flushed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | The new title for the document |
| `content` | string | No | The new content for the document. |
| `content_format` | string ("markdown" | "html") | No | Format of content. For input: specifies format of provided content (defaults to 'html'). For output: controls response format - 'markdown' (default) or 'html' to include HTML content. |
| `doc__public__id` | string | Yes | The Doc's public ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update entity template

**Slug:** `SHORTCUT_UPDATE_ENTITY_TEMPLATE`

Update an entity template's name or its contents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The updated template name. |
| `story__contents__name` | string | No | The name of the story. |
| `story__contents__tasks` | array | No | An array of tasks to be populated by the template. |
| `story__contents__labels` | array | No | An array of labels to be populated by the template. |
| `story__contents__deadline` | string | No | The due date of the story. |
| `story__contents__epic__id` | integer | No | The ID of the epic the to be populated. |
| `story__contents__estimate` | integer | No | The numeric point estimate to be populated. |
| `story__contents__file__ids` | array | No | An array of the attached file IDs to be populated. |
| `story__contents__group__id` | string | No | The ID of the group to be populated. |
| `story__contents__owner__ids` | array | No | An array of UUIDs of the owners of this story. |
| `entity__template__public__id` | string | Yes | The unique ID of the template to be updated. |
| `story__contents__description` | string | No | The description of the story. |
| `story__contents__project__id` | integer | No | The ID of the project the story belongs to. |
| `story__contents__story__type` | string | No | The type of story (feature, bug, chore). |
| `story__contents__follower__ids` | array | No | An array of UUIDs for any Members listed as Followers. |
| `story__contents__iteration__id` | integer | No | The ID of the iteration the to be populated. |
| `story__contents__custom__fields` | array | No | An array of maps specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.  |
| `story__contents__external__links` | array | No | An array of external links to be populated. |
| `story__contents__linked__file__ids` | array | No | An array of the linked file IDs to be populated. |
| `story__contents__workflow__state__id` | integer | No | The ID of the workflow state to be populated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update epic

**Slug:** `SHORTCUT_UPDATE_EPIC`

Update Epic can be used to update numerous fields in the Epic. The only required parameter is Epic ID, which can be found in the Shortcut UI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The Epic"s name. |
| `state` | string ("in progress" | "to do" | "done") | No | `Deprecated` The Epic"s state (to do, in progress, or done); will be ignored when `epic_state_id` is set.  |
| `labels` | array | No | An array of Labels attached to the Epic. |
| `after_id` | integer | No | The ID of the Epic we want to move this Epic after. |
| `archived` | boolean | No | A true/false boolean indicating whether the Epic is in archived state. |
| `deadline` | string | No | The Epic"s deadline. |
| `group_id` | string | No | `Deprecated` The ID of the group to associate with the epic. Use `group_ids`.  |
| `before_id` | integer | No | The ID of the Epic we want to move this Epic before. |
| `group_ids` | array | No | An array of UUIDS for Groups to which this Epic is related. |
| `owner_ids` | array | No | An array of UUIDs for any members you want to add as Owners on this Epic.  |
| `description` | string | No | The Epic"s description. |
| `external_id` | string | No | This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here.  |
| `follower_ids` | array | No | An array of UUIDs for any Members you want to add as Followers on this Epic.  |
| `milestone_id` | integer | No | `Deprecated` The ID of the Milestone this Epic is related to. Use `objective_ids`.  |
| `epic_state_id` | integer | No | The ID of the Epic State. |
| `objective_ids` | array | No | An array of IDs for Objectives to which this Epic is related. |
| `requested_by_id` | string | No | The ID of the member that requested the epic. |
| `epic__public__id` | integer | Yes | The unique ID of the Epic. |
| `planned_start_date` | string | No | The Epic"s planned start date. |
| `started_at_override` | string | No | A manual override for the time/date the Epic was started. |
| `completed_at_override` | string | No | A manual override for the time/date the Epic was completed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update epic comment

**Slug:** `SHORTCUT_UPDATE_EPIC_COMMENT`

This endpoint allows you to update a threaded Comment on an Epic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The updated comment text. |
| `epic__public__id` | integer | Yes | The ID of the associated Epic. |
| `comment__public__id` | integer | Yes | The ID of the Comment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update file

**Slug:** `SHORTCUT_UPDATE_FILE`

Update File updates the properties of an UploadedFile (but not its content).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the file. |
| `created_at` | string | No | The time/date that the file was uploaded. |
| `updated_at` | string | No | The time/date that the file was last updated. |
| `description` | string | No | The description of the file. |
| `external_id` | string | No | An additional ID that you may wish to assign to the file. |
| `uploader_id` | string | No | The unique ID assigned to the Member who uploaded the file to Shortcut. |
| `file__public__id` | integer | Yes | The unique ID assigned to the file in Shortcut. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update group

**Slug:** `SHORTCUT_UPDATE_GROUP`

Updates an existing group in the Shortcut workspace. This endpoint allows you to modify various properties of a group, including its name, description, color, members, and associated workflows. Use this when you need to change group details, add or remove members, or update the group's visual representation. It's particularly useful for team reorganizations, project changes, or general maintenance of your Shortcut workspace structure. Note that while many fields are optional, you should include any fields you wish to modify; omitted fields will retain their current values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of this Group. |
| `color` | string | No | The color you wish to use for the Group in the system. |
| `archived` | boolean | No | Whether or not this Group is archived. |
| `color_key` | string ("blue" | "purple" | "midnight-blue" | "orange" | "yellow-green" | "brass" | "gray" | "fuchsia" | "yellow" | "pink" | "sky-blue" | "green" | "red" | "black" | "slate" | "turquoise") | No | The color key you wish to use for the Group in the system. |
| `member_ids` | array | No | The Member ids to add to this Group. |
| `description` | string | No | The description of this Group. |
| `mention_name` | string | No | The mention name of this Group. |
| `workflow_ids` | array | No | The Workflow ids to add to the Group. |
| `display_icon_id` | string | No | The Icon id for the avatar of this Group. |
| `group__public__id` | string | Yes | The unique ID of the Group. |
| `default_workflow_id` | integer | No | The ID of the default workflow for stories created in this group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update health status

**Slug:** `SHORTCUT_UPDATE_HEALTH`

Update an existing health status by its ID. Use when you need to modify the health tracking status of an Epic or Objective.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The description of the Health status. |
| `status` | string ("At Risk" | "On Track" | "Off Track" | "No Health") | No | Health status of the Epic or Objective. |
| `health_public_id` | string | Yes | The unique ID of the Health record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update iteration

**Slug:** `SHORTCUT_UPDATE_ITERATION`

This endpoint allows you to update an existing iteration in Shortcut. It provides comprehensive control over various aspects of an iteration, including its metadata, associated members and groups, labels, and timeframe. Use this endpoint when you need to modify any details of an ongoing or upcoming iteration, such as adjusting dates, adding followers, or updating labels. The endpoint is particularly useful for project managers or team leads who need to refine iteration details as the project progresses. Note that while you can update multiple aspects of an iteration in a single call, only the fields you include in the request will be modified; omitted fields will retain their current values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of this Iteration |
| `labels` | array | No | An array of Labels attached to the Iteration. |
| `end_date` | string | No | The date this Iteration ends, e.g. 2019-07-05. |
| `group_ids` | array | No | An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI.  |
| `start_date` | string | No | The date this Iteration begins, e.g. 2019-07-01 |
| `description` | string | No | The description of the Iteration. |
| `follower_ids` | array | No | An array of UUIDs for any Members you want to add as Followers. |
| `iteration__public__id` | integer | Yes | The unique ID of the Iteration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update key result

**Slug:** `SHORTCUT_UPDATE_KEY_RESULT`

Update Key Result allows updating a Key Result's name or initial, observed, or target values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the Key Result. |
| `key__result__public__id` | string | Yes | The ID of the Key Result. |
| `target__value__boolean__value` | boolean | No | The boolean value. |
| `target__value__numeric__value` | string | No | The numeric value, as a decimal string. No more than two decimal places are allowed.  |
| `observed__value__boolean__value` | boolean | No | The boolean value. |
| `observed__value__numeric__value` | string | No | The numeric value, as a decimal string. No more than two decimal places are allowed.  |
| `initial__observed__value__boolean__value` | boolean | No | The boolean value. |
| `initial__observed__value__numeric__value` | string | No | The numeric value, as a decimal string. No more than two decimal places are allowed.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update label

**Slug:** `SHORTCUT_UPDATE_LABEL`

Update Label allows you to replace a Label name with another name. If you try to name a Label something that already exists, you will receive a 422 response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The new name of the label. |
| `color` | string | No | The hex color to be displayed with the Label (for example, "#ff0000"). |
| `archived` | boolean | No | A true/false boolean indicating if the Label has been archived. |
| `description` | string | No | The new description of the label. |
| `label__public__id` | integer | Yes | The unique ID of the Label you wish to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update linked file

**Slug:** `SHORTCUT_UPDATE_LINKED_FILE`

Updated Linked File allows you to update properties of a previously attached Linked-File.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | The URL of linked file. |
| `name` | string | No | The name of the file. |
| `size` | integer | No | The filesize, if the integration provided it. |
| `type` | string ("google" | "url" | "dropbox" | "box" | "onedrive") | No | The integration type of the file (e.g. google, dropbox, box). |
| `story_id` | integer | No | The ID of the linked story. |
| `description` | string | No | The description of the file. |
| `uploader_id` | string | No | The UUID of the member that uploaded the file. |
| `thumbnail_url` | string | No | The URL of the thumbnail, if the integration provided it. |
| `linked__file__public__id` | integer | Yes | The unique identifier of the linked file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update milestone

**Slug:** `SHORTCUT_UPDATE_MILESTONE`

(Deprecated: Use 'Update Objective') Update Milestone can be used to update Milestone properties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the Milestone. |
| `state` | string ("in progress" | "to do" | "done") | No | The workflow state that the Milestone is in. |
| `after_id` | integer | No | The ID of the Milestone we want to move this Milestone after. |
| `archived` | boolean | No | A boolean indicating whether the Milestone is archived or not |
| `before_id` | integer | No | The ID of the Milestone we want to move this Milestone before. |
| `categories` | array | No | An array of IDs of Categories attached to the Milestone. |
| `description` | string | No | The Milestone"s description. |
| `started_at_override` | string | No | A manual override for the time/date the Milestone was started. |
| `completed_at_override` | string | No | A manual override for the time/date the Milestone was completed. |
| `milestone__public__id` | integer | Yes | The ID of the Milestone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update multiple stories

**Slug:** `SHORTCUT_UPDATE_MULTIPLE_STORIES`

Update Multiple Stories allows you to make changes to numerous stories at once.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic_id` | integer | No | The ID of the epic the story belongs to. |
| `move_to` | string ("last" | "first") | No | One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state.  |
| `after_id` | integer | No | The ID of the story that the stories are to be moved below. |
| `archived` | boolean | No | If the Stories should be archived or not. |
| `deadline` | string | No | The due date of the story. |
| `estimate` | integer | No | The numeric point estimate of the story. Can also be null, which means unestimated.  |
| `group_id` | string | No | The Id of the Group the Stories should belong to. |
| `before_id` | integer | No | The ID of the story that the stories are to be moved before. |
| `story_ids` | array | Yes | The Ids of the Stories you wish to update. |
| `labels_add` | array | No | An array of labels to be added. |
| `project_id` | integer | No | The ID of the Project the Stories should belong to. |
| `story_type` | string ("feature" | "chore" | "bug") | No | The type of story (feature, bug, chore). |
| `iteration_id` | integer | No | The ID of the iteration the story belongs to. |
| `labels_remove` | array | No | An array of labels to be removed. |
| `owner_ids_add` | array | No | The UUIDs of the new owners to be added. |
| `external_links` | array | No | An array of External Links associated with this story. |
| `requested_by_id` | string | No | The ID of the member that requested the story. |
| `follower_ids_add` | array | No | The UUIDs of the new followers to be added. |
| `owner_ids_remove` | array | No | The UUIDs of the owners to be removed. |
| `custom_fields_add` | array | No | A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.  |
| `workflow_state_id` | integer | No | The ID of the workflow state to put the stories in. |
| `follower_ids_remove` | array | No | The UUIDs of the followers to be removed. |
| `custom_fields_remove` | array | No | A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update objective

**Slug:** `SHORTCUT_UPDATE_OBJECTIVE`

Update Objective can be used to update Objective properties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the Objective. |
| `state` | string ("in progress" | "to do" | "done") | No | The workflow state that the Objective is in. |
| `after_id` | integer | No | The ID of the Objective we want to move this Objective after. |
| `archived` | boolean | No | A boolean indicating whether the Objective is archived or not |
| `before_id` | integer | No | The ID of the Objective we want to move this Objective before. |
| `categories` | array | No | An array of IDs of Categories attached to the Objective. |
| `description` | string | No | The Objective"s description. |
| `started_at_override` | string | No | A manual override for the time/date the Objective was started. |
| `completed_at_override` | string | No | A manual override for the time/date the Objective was completed. |
| `objective__public__id` | integer | Yes | The ID of the Objective. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project

**Slug:** `SHORTCUT_UPDATE_PROJECT`

Update Project can be used to change properties of a Project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The Project"s name. |
| `color` | string | No | The color that represents the Project in the UI. |
| `team_id` | integer | No | The ID of the team the project belongs to. |
| `archived` | boolean | No | A true/false boolean indicating whether the Story is in archived state. |
| `description` | string | No | The Project"s description. |
| `abbreviation` | string | No | The Project abbreviation used in Story summaries. Should be kept to 3 characters at most.  |
| `follower_ids` | array | No | An array of UUIDs for any Members you want to add as Followers. |
| `show_thermometer` | boolean | No | Configuration to enable or disable thermometers in the Story summary. |
| `days_to_thermometer` | integer | No | The number of days before the thermometer appears in the Story summary. |
| `project__public__id` | integer | Yes | The unique ID of the Project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update story

**Slug:** `SHORTCUT_UPDATE_STORY`

Update Story can be used to update Story properties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The title of the story. |
| `labels` | array | No | An array of labels attached to the story. |
| `epic_id` | integer | No | The ID of the epic the story belongs to. |
| `move_to` | string ("last" | "first") | No | One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state.  |
| `after_id` | integer | No | The ID of the story we want to move this story after. |
| `archived` | boolean | No | True if the story is archived, otherwise false. |
| `deadline` | string | No | The due date of the story. |
| `estimate` | integer | No | The numeric point estimate of the story. Can also be null, which means unestimated.  |
| `file_ids` | array | No | An array of IDs of files attached to the story. |
| `group_id` | string | No | The ID of the group to associate with this story |
| `before_id` | integer | No | The ID of the story we want to move this story before. |
| `owner_ids` | array | No | An array of UUIDs of the owners of this story. |
| `branch_ids` | array | No | An array of IDs of Branches attached to the story. |
| `commit_ids` | array | No | An array of IDs of Commits attached to the story. |
| `project_id` | integer | No | The ID of the project the story belongs to. |
| `story_type` | string ("feature" | "chore" | "bug") | No | The type of story (feature, bug, chore). |
| `description` | string | No | The description of the story. |
| `follower_ids` | array | No | An array of UUIDs of the followers of this story. |
| `iteration_id` | integer | No | The ID of the iteration the story belongs to. |
| `custom_fields` | array | No | A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.  |
| `external_links` | array | No | An array of External Links associated with this story. |
| `linked_file_ids` | array | No | An array of IDs of linked files attached to the story. |
| `requested_by_id` | string | No | The ID of the member that requested the story. |
| `pull_request_ids` | array | No | An array of IDs of Pull/Merge Requests attached to the story. |
| `story__public__id` | integer | Yes | The unique identifier of this story. |
| `workflow_state_id` | integer | No | The ID of the workflow state to put the story in. |
| `started_at_override` | string | No | A manual override for the time/date the Story was started. |
| `completed_at_override` | string | No | A manual override for the time/date the Story was completed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update story comment

**Slug:** `SHORTCUT_UPDATE_STORY_COMMENT`

Update Comment replaces the text of the existing Comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The updated comment text. |
| `story__public__id` | integer | Yes | The ID of the Story that the Comment is in. |
| `comment__public__id` | integer | Yes | The ID of the Comment |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update story link

**Slug:** `SHORTCUT_UPDATE_STORY_LINK`

Updates the stories and/or the relationship for the given Story Link.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `verb` | string ("blocks" | "duplicates" | "relates to") | No | The type of link. |
| `object_id` | integer | No | The ID of the object Story. |
| `subject_id` | integer | No | The ID of the subject Story. |
| `story__link__public__id` | integer | Yes | The unique ID of the Story Link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update task

**Slug:** `SHORTCUT_UPDATE_TASK`

Update Task can be used to update Task properties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after_id` | integer | No | Move task after this task ID. |
| `complete` | boolean | No | A true/false boolean indicating whether the task is complete. |
| `before_id` | integer | No | Move task before this task ID. |
| `owner_ids` | array | No | An array of UUIDs of the owners of this story. |
| `description` | string | No | The Task"s description. |
| `task__public__id` | integer | Yes | The unique identifier of the Task you wish to update. |
| `story__public__id` | integer | Yes | The unique identifier of the parent Story. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload files

**Slug:** `SHORTCUT_UPLOAD_FILES`

Upload Files uploads one or many files and optionally associates them with a story. Use the multipart/form-data content-type to upload. Each `file` key should contain a separate file. Each UploadedFile's name comes from the Content-Disposition header "filename" directive for that field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file0` | object | No | A file upload. At least one is required. Provide as FileType with 'name' and 'content' (base64 encoded). |
| `file1` | object | No | Optional additional file. Provide as FileType with 'name' and 'content' (base64 encoded). |
| `file2` | object | No | Optional additional file. Provide as FileType with 'name' and 'content' (base64 encoded). |
| `file3` | object | No | Optional additional file. Provide as FileType with 'name' and 'content' (base64 encoded). |
| `story_id` | integer | No | The story ID that these files will be associated with. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
