> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # shortcut-stories > Shortcut Stories - create, update, search, and manage stories, tasks, comments, and story links **Server path:** `/shortcut-stories` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------- | -------------------------------- | | [`shortcut_stories_create_multiple_stories`](#shortcut_stories_create_multiple_stories) | Create Multiple Stories | | [`shortcut_stories_create_story`](#shortcut_stories_create_story) | Create Story | | [`shortcut_stories_create_story_comment`](#shortcut_stories_create_story_comment) | Create Story Comment | | [`shortcut_stories_create_story_from_template`](#shortcut_stories_create_story_from_template) | Create Story From Template | | [`shortcut_stories_create_story_link`](#shortcut_stories_create_story_link) | Create Story Link | | [`shortcut_stories_create_story_reaction`](#shortcut_stories_create_story_reaction) | Create Story Reaction | | [`shortcut_stories_create_task`](#shortcut_stories_create_task) | Create Task | | [`shortcut_stories_delete_multiple_stories`](#shortcut_stories_delete_multiple_stories) | Delete Multiple Stories | | [`shortcut_stories_delete_story`](#shortcut_stories_delete_story) | Delete Story | | [`shortcut_stories_delete_story_comment`](#shortcut_stories_delete_story_comment) | Delete Story Comment | | [`shortcut_stories_delete_story_link`](#shortcut_stories_delete_story_link) | Delete Story Link | | [`shortcut_stories_delete_story_reaction`](#shortcut_stories_delete_story_reaction) | Delete Story Reaction | | [`shortcut_stories_delete_task`](#shortcut_stories_delete_task) | Delete Task | | [`shortcut_stories_get_external_link_stories`](#shortcut_stories_get_external_link_stories) | Get External Link Stories | | [`shortcut_stories_get_story`](#shortcut_stories_get_story) | Get Story | | [`shortcut_stories_get_story_comment`](#shortcut_stories_get_story_comment) | Get Story Comment | | [`shortcut_stories_get_story_link`](#shortcut_stories_get_story_link) | Get Story Link | | [`shortcut_stories_get_task`](#shortcut_stories_get_task) | Get Task | | [`shortcut_stories_list_story_comment`](#shortcut_stories_list_story_comment) | List Story Comment | | [`shortcut_stories_list_story_sub_tasks`](#shortcut_stories_list_story_sub_tasks) | List Story Sub tasks | | [`shortcut_stories_query_stories`](#shortcut_stories_query_stories) | Query Stories | | [`shortcut_stories_search`](#shortcut_stories_search) | Search | | [`shortcut_stories_search_documents`](#shortcut_stories_search_documents) | Search Documents | | [`shortcut_stories_search_epics`](#shortcut_stories_search_epics) | Search Epics | | [`shortcut_stories_search_iterations`](#shortcut_stories_search_iterations) | Search Iterations | | [`shortcut_stories_search_milestones`](#shortcut_stories_search_milestones) | Search Milestones | | [`shortcut_stories_search_objectives`](#shortcut_stories_search_objectives) | Search Objectives | | [`shortcut_stories_search_stories`](#shortcut_stories_search_stories) | Search Stories | | [`shortcut_stories_story_history`](#shortcut_stories_story_history) | Story History | | [`shortcut_stories_unlink_comment_thread_from_slack`](#shortcut_stories_unlink_comment_thread_from_slack) | Unlink Comment thread from Slack | | [`shortcut_stories_update_multiple_stories`](#shortcut_stories_update_multiple_stories) | Update Multiple Stories | | [`shortcut_stories_update_story`](#shortcut_stories_update_story) | Update Story | | [`shortcut_stories_update_story_comment`](#shortcut_stories_update_story_comment) | Update Story Comment | | [`shortcut_stories_update_story_link`](#shortcut_stories_update_story_link) | Update Story Link | | [`shortcut_stories_update_task`](#shortcut_stories_update_task) | Update Task | *** ## shortcut\_stories\_create\_multiple\_stories Create Multiple Stories **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------------------- | | `stories` | object\[] | Yes | — | An array of stories to be created. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stories": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description of the story." }, "archived": { "type": "boolean", "description": "Controls the story's archived state." }, "story_links": { "type": "array", "items": { "type": "object", "properties": { "subject_id": { "type": "integer", "description": "The unique ID of the Story defined as subject." }, "verb": { "type": "string", "description": "How the subject Story acts on the object Story. This can be \"blocks\", \"duplicates\", or \"relates to\"." }, "object_id": { "type": "integer", "description": "The unique ID of the Story defined as object." } } }, "description": "An array of story links attached to the story." }, "labels": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the new Label." }, "description": { "type": "string", "description": "The description of the new Label." }, "color": { "type": "string", "description": "The hex color to be displayed with the Label (for example, \"#ff0000\")." }, "external_id": { "type": "string", "description": "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." } } }, "description": "An array of labels attached to the story." }, "story_type": { "type": "string", "enum": [ "feature", "chore", "bug" ], "description": "The type of story (feature, bug, chore)." }, "custom_fields": { "type": "array", "items": { "type": "object", "properties": { "field_id": { "type": "string", "description": "The unique public ID for the CustomField." }, "value_id": { "type": "string", "description": "The unique public ID for the CustomFieldEnumValue." }, "value": { "type": "string", "description": "A literal value for the CustomField. Currently ignored." } } }, "description": "A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField." }, "move_to": { "type": "string", "enum": [ "last", "first" ], "description": "One of \"first\" or \"last\". This can be used to move the given story to the first or last position in the workflow state." }, "file_ids": { "type": "array", "items": { "type": "integer" }, "description": "An array of IDs of files attached to the story." }, "source_task_id": { "type": "integer", "format": "int64", "description": "Given this story was converted from a task in another story, this is the original task ID that was converted to this story." }, "completed_at_override": { "type": "string", "format": "date-time", "description": "A manual override for the time/date the Story was completed." }, "name": { "type": "string", "description": "The name of the story." }, "comments": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The comment text." }, "author_id": { "type": "string", "description": "The Member ID of the Comment's author. Defaults to the user identified by the API token." }, "created_at": { "type": "string", "description": "Defaults to the time/date the comment is created, but can be set to reflect another date." }, "updated_at": { "type": "string", "description": "Defaults to the time/date the comment is last updated, but can be set to reflect another date." }, "external_id": { "type": "string", "description": "This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here." }, "parent_id": { "type": "integer", "description": "The ID of the Comment that this comment is threaded under." } } }, "description": "An array of comments to add to the story." }, "epic_id": { "type": "integer", "format": "int64", "description": "The ID of the epic the story belongs to." }, "story_template_id": { "type": "string", "format": "uuid", "description": "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." }, "external_links": { "type": "array", "items": { "type": "string" }, "description": "An array of External Links associated with this story." }, "sub_tasks": { "type": "array", "description": "An array of maps specifying sub-tasks to be associated with the created story. Each map can either link to an existing story or create a new sub-task story to be linked to the created story. Field only applicable when Sub-task feature is enabled." }, "requested_by_id": { "type": "string", "format": "uuid", "description": "The ID of the member that requested the story." }, "iteration_id": { "type": "integer", "format": "int64", "description": "The ID of the iteration the story belongs to." }, "tasks": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The Task description." }, "complete": { "type": "boolean", "description": "True/false boolean indicating whether the Task is completed. Defaults to false." }, "owner_ids": { "type": "array", "description": "An array of UUIDs for any members you want to add as Owners on this new Task." }, "external_id": { "type": "string", "description": "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." }, "created_at": { "type": "string", "description": "Defaults to the time/date the Task is created but can be set to reflect another creation time/date." }, "updated_at": { "type": "string", "description": "Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date." } } }, "description": "An array of tasks connected to the story." }, "started_at_override": { "type": "string", "format": "date-time", "description": "A manual override for the time/date the Story was started." }, "group_id": { "type": "string", "format": "uuid", "description": "The id of the group to associate with this story." }, "workflow_state_id": { "type": "integer", "format": "int64", "description": "The ID of the workflow state the story will be in." }, "updated_at": { "type": "string", "format": "date-time", "description": "The time/date the Story was updated." }, "follower_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of UUIDs of the followers of this story." }, "owner_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of UUIDs of the owners of this story." }, "external_id": { "type": "string", "description": "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." }, "parent_story_id": { "type": "integer", "format": "int64", "description": "The ID of the parent story to associate with this story (making the created story a sub-task). Field only applicable when Sub-task feature is enabled." }, "estimate": { "type": "integer", "format": "int64", "description": "The numeric point estimate of the story. Can also be null, which means unestimated." }, "project_id": { "type": "integer", "format": "int64", "description": "The ID of the project the story belongs to." }, "linked_file_ids": { "type": "array", "items": { "type": "integer" }, "description": "An array of IDs of linked files attached to the story." }, "deadline": { "type": "string", "format": "date-time", "description": "The due date of the story." }, "created_at": { "type": "string", "format": "date-time", "description": "The time/date the Story was created." } }, "required": [ "name" ] }, "description": "An array of stories to be created." } }, "required": [ "PCID", "stories" ] } ``` *** ## shortcut\_stories\_create\_story Create Story **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `archived` | boolean | No | — | Controls the story's archived state. | | | `comments` | object\[] | No | — | An array of comments to add to the story. | | | `completed_at_override` | string | No | — | A manual override for the time/date the Story was completed. | | | `created_at` | string | No | — | The time/date the Story was created. | | | `custom_fields` | object\[] | No | — | A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. | | | `deadline` | string | null | No | — | The due date of the story. | | `description` | string | No | — | The description of the story. | | | `epic_id` | integer | null | No | — | The ID of the epic the story belongs to. | | `estimate` | integer | null | No | — | The numeric point estimate of the story. Can also be null, which means unestimated. | | `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. | | | `external_links` | string\[] | No | — | An array of External Links associated with this story. | | | `file_ids` | integer\[] | No | — | An array of IDs of files attached to the story. | | | `follower_ids` | string\[] | No | — | An array of UUIDs of the followers of this story. | | | `group_id` | string | null | No | — | The id of the group to associate with this story. | | `iteration_id` | integer | null | No | — | The ID of the iteration the story belongs to. | | `labels` | object\[] | No | — | An array of labels attached to the story. | | | `linked_file_ids` | integer\[] | No | — | An array of IDs of linked files attached to the story. | | | `move_to` | string | 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. | | | `name` | string | Yes | — | The name of the story. | | | `owner_ids` | string\[] | No | — | An array of UUIDs of the owners of this story. | | | `parent_story_id` | integer | null | No | — | The ID of the parent story to associate with this story (making the created story a sub-task). Field only applicable when Sub-task feature is enabled. | | `project_id` | integer | null | No | — | The ID of the project the story belongs to. | | `requested_by_id` | string | No | — | The ID of the member that requested the story. | | | `source_task_id` | integer | null | No | — | Given this story was converted from a task in another story, this is the original task ID that was converted to this story. | | `started_at_override` | string | No | — | A manual override for the time/date the Story was started. | | | `story_links` | object\[] | No | — | An array of story links attached to the story. | | | `story_template_id` | string | null | 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. | | `story_type` | string | No | — | The type of story (feature, bug, chore). | | | `sub_tasks` | any\[] | No | — | An array of maps specifying sub-tasks to be associated with the created story. Each map can either link to an existing story or create a new sub-task story to be linked to the created story. Field only applicable when Sub-task feature is enabled. | | | `tasks` | object\[] | No | — | An array of tasks connected to the story. | | | `updated_at` | string | No | — | The time/date the Story was updated. | | | `workflow_state_id` | integer | No | — | The ID of the workflow state the story will be in. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "archived": { "type": "boolean", "description": "Controls the story's archived state." }, "comments": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The comment text." }, "author_id": { "type": "string", "format": "uuid", "description": "The Member ID of the Comment's author. Defaults to the user identified by the API token." }, "created_at": { "type": "string", "format": "date-time", "description": "Defaults to the time/date the comment is created, but can be set to reflect another date." }, "updated_at": { "type": "string", "format": "date-time", "description": "Defaults to the time/date the comment is last updated, but can be set to reflect another date." }, "external_id": { "type": "string", "description": "This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here." }, "parent_id": { "type": "integer", "format": "int64", "description": "The ID of the Comment that this comment is threaded under." } }, "required": [ "text" ] }, "description": "An array of comments to add to the story." }, "completed_at_override": { "type": "string", "description": "A manual override for the time/date the Story was completed." }, "created_at": { "type": "string", "description": "The time/date the Story was created." }, "custom_fields": { "type": "array", "items": { "type": "object", "properties": { "field_id": { "type": "string", "format": "uuid", "description": "The unique public ID for the CustomField." }, "value_id": { "type": "string", "format": "uuid", "description": "The unique public ID for the CustomFieldEnumValue." }, "value": { "type": "string", "description": "A literal value for the CustomField. Currently ignored." } }, "required": [ "field_id", "value_id" ] }, "description": "A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField." }, "deadline": { "type": [ "string", "null" ], "description": "The due date of the story." }, "description": { "type": "string", "description": "The description of the story." }, "epic_id": { "type": [ "integer", "null" ], "description": "The ID of the epic the story belongs to." }, "estimate": { "type": [ "integer", "null" ], "description": "The numeric point estimate of the story. Can also be null, which means unestimated." }, "external_id": { "type": "string", "description": "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." }, "external_links": { "type": "array", "items": { "type": "string" }, "description": "An array of External Links associated with this story." }, "file_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "An array of IDs of files attached to the story." }, "follower_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs of the followers of this story." }, "group_id": { "type": [ "string", "null" ], "description": "The id of the group to associate with this story." }, "iteration_id": { "type": [ "integer", "null" ], "description": "The ID of the iteration the story belongs to." }, "labels": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the new Label." }, "description": { "type": "string", "description": "The description of the new Label." }, "color": { "type": "string", "format": "css-color", "description": "The hex color to be displayed with the Label (for example, \"#ff0000\")." }, "external_id": { "type": "string", "description": "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." } }, "required": [ "name" ] }, "description": "An array of labels attached to the story." }, "linked_file_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "An array of IDs of linked files attached to the story." }, "move_to": { "type": "string", "description": "One of \"first\" or \"last\". This can be used to move the given story to the first or last position in the workflow state.", "enum": [ "last", "first" ] }, "name": { "type": "string", "description": "The name of the story." }, "owner_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs of the owners of this story." }, "parent_story_id": { "type": [ "integer", "null" ], "description": "The ID of the parent story to associate with this story (making the created story a sub-task). Field only applicable when Sub-task feature is enabled." }, "project_id": { "type": [ "integer", "null" ], "description": "The ID of the project the story belongs to." }, "requested_by_id": { "type": "string", "description": "The ID of the member that requested the story." }, "source_task_id": { "type": [ "integer", "null" ], "description": "Given this story was converted from a task in another story, this is the original task ID that was converted to this story." }, "started_at_override": { "type": "string", "description": "A manual override for the time/date the Story was started." }, "story_links": { "type": "array", "items": { "type": "object", "properties": { "subject_id": { "type": "integer", "format": "int64", "description": "The unique ID of the Story defined as subject." }, "verb": { "type": "string", "enum": [ "blocks", "duplicates", "relates to" ], "description": "How the subject Story acts on the object Story. This can be \"blocks\", \"duplicates\", or \"relates to\"." }, "object_id": { "type": "integer", "format": "int64", "description": "The unique ID of the Story defined as object." } }, "required": [ "verb" ] }, "description": "An array of story links attached to the story." }, "story_template_id": { "type": [ "string", "null" ], "description": "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." }, "story_type": { "type": "string", "description": "The type of story (feature, bug, chore).", "enum": [ "feature", "chore", "bug" ] }, "sub_tasks": { "type": "array", "description": "An array of maps specifying sub-tasks to be associated with the created story. Each map can either link to an existing story or create a new sub-task story to be linked to the created story. Field only applicable when Sub-task feature is enabled." }, "tasks": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The Task description." }, "complete": { "type": "boolean", "description": "True/false boolean indicating whether the Task is completed. Defaults to false." }, "owner_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of UUIDs for any members you want to add as Owners on this new Task." }, "external_id": { "type": "string", "description": "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." }, "created_at": { "type": "string", "format": "date-time", "description": "Defaults to the time/date the Task is created but can be set to reflect another creation time/date." }, "updated_at": { "type": "string", "format": "date-time", "description": "Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date." } }, "required": [ "description" ] }, "description": "An array of tasks connected to the story." }, "updated_at": { "type": "string", "description": "The time/date the Story was updated." }, "workflow_state_id": { "type": "integer", "description": "The ID of the workflow state the story will be in." } }, "required": [ "PCID", "name" ] } ``` *** ## shortcut\_stories\_create\_story\_comment Create Story Comment **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | | `story-public-id` | integer | Yes | — | The ID of the Story that the Comment is in. | | | `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. | | | `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. | | | `parent_id` | integer | null | No | — | The ID of the Comment that this comment is threaded under. | | `text` | string | Yes | — | The comment text. | | | `updated_at` | string | No | — | Defaults to the time/date the comment is last updated, but can be set to reflect another date. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The ID of the Story that the Comment is in." }, "author_id": { "type": "string", "description": "The Member ID of the Comment's author. Defaults to the user identified by the API token." }, "created_at": { "type": "string", "description": "Defaults to the time/date the comment is created, but can be set to reflect another date." }, "external_id": { "type": "string", "description": "This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here." }, "parent_id": { "type": [ "integer", "null" ], "description": "The ID of the Comment that this comment is threaded under." }, "text": { "type": "string", "description": "The comment text." }, "updated_at": { "type": "string", "description": "Defaults to the time/date the comment is last updated, but can be set to reflect another date." } }, "required": [ "PCID", "story-public-id", "text" ] } ``` *** ## shortcut\_stories\_create\_story\_from\_template Create Story From Template **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------------------ | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `archived` | boolean | No | — | Controls the story's archived state. | | | `comments` | object\[] | No | — | An array of comments to add to the story. | | | `completed_at_override` | string | No | — | A manual override for the time/date the Story was completed. | | | `created_at` | string | No | — | The time/date the Story was created. | | | `custom_fields` | object\[] | No | — | A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. | | | `custom_fields_add` | object\[] | 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`. | | | `custom_fields_remove` | object\[] | 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`. | | | `deadline` | string | null | No | — | The due date of the story. | | `description` | string | No | — | The description of the story. | | | `epic_id` | integer | null | No | — | The ID of the epic the story belongs to. | | `estimate` | integer | null | No | — | The numeric point estimate of the story. Can also be null, which means unestimated. | | `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. | | | `external_links` | string\[] | No | — | An array of External Links associated with this story. | | | `external_links_add` | string\[] | 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`. | | | `external_links_remove` | string\[] | 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`. | | | `file_ids` | integer\[] | No | — | An array of IDs of files attached to the story. | | | `file_ids_add` | integer\[] | 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`. | | | `file_ids_remove` | integer\[] | No | — | An array of IDs of files removed from files from the template. Cannot be used in conjunction with `file_ids`. | | | `follower_ids` | string\[] | No | — | An array of UUIDs of the followers of this story. | | | `follower_ids_add` | string\[] | 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.` | | | `follower_ids_remove` | string\[] | No | — | The UUIDs of the new followers to be removed from followers from the template. Cannot be used in conjunction with `follower_ids`. | | | `group_id` | string | null | No | — | The id of the group to associate with this story. | | `iteration_id` | integer | null | No | — | The ID of the iteration the story belongs to. | | `labels` | object\[] | No | — | An array of labels attached to the story. | | | `labels_add` | object\[] | 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`. | | | `labels_remove` | object\[] | No | — | An array of labels to remove from the labels provided by the template. Cannot be used in conjunction with `labels`. | | | `linked_file_ids` | integer\[] | No | — | An array of IDs of linked files attached to the story. | | | `linked_file_ids_add` | integer\[] | 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`. | | | `linked_file_ids_remove` | integer\[] | No | — | An array of IDs of linked files removed from files from the template. Cannot be used in conjunction with `linked_files.` | | | `move_to` | string | 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. | | | `name` | string | No | — | The name of the story. Must be provided if the template does not provide a name. | | | `owner_ids` | string\[] | No | — | An array of UUIDs of the owners of this story. | | | `owner_ids_add` | string\[] | No | — | The UUIDs of the new owners to be added in addition to owners from the template. Cannot be used in conjunction with `owners`. | | | `owner_ids_remove` | string\[] | No | — | The UUIDs of the new owners to be removed from owners from the template. Cannot be used in conjunction with `owners`. | | | `parent_story_id` | integer | null | No | — | The ID of the parent story to associate with this story (making the created story a sub-task). Field only applicable when Sub-task feature is enabled. | | `project_id` | integer | null | No | — | The ID of the project the story belongs to. | | `requested_by_id` | string | No | — | The ID of the member that requested the story. | | | `source_task_id` | integer | null | No | — | Given this story was converted from a task in another story, this is the original task ID that was converted to this story. | | `started_at_override` | string | No | — | A manual override for the time/date the Story was started. | | | `story_links` | object\[] | No | — | An array of story links attached to the story. | | | `story_template_id` | string | Yes | — | The id of the story template used to create this story. | | | `story_type` | string | No | — | The type of story (feature, bug, chore). | | | `sub_tasks` | any\[] | No | — | An array of maps specifying sub-tasks to be associated with the created story. Each map can either link to an existing story or create a new sub-task story to be linked to the created story. Field only applicable when Sub-task feature is enabled. | | | `tasks` | object\[] | No | — | An array of tasks connected to the story. | | | `updated_at` | string | No | — | The time/date the Story was updated. | | | `workflow_state_id` | integer | No | — | The ID of the workflow state the story will be in. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "archived": { "type": "boolean", "description": "Controls the story's archived state." }, "comments": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The comment text." }, "author_id": { "type": "string", "format": "uuid", "description": "The Member ID of the Comment's author. Defaults to the user identified by the API token." }, "created_at": { "type": "string", "format": "date-time", "description": "Defaults to the time/date the comment is created, but can be set to reflect another date." }, "updated_at": { "type": "string", "format": "date-time", "description": "Defaults to the time/date the comment is last updated, but can be set to reflect another date." }, "external_id": { "type": "string", "description": "This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here." }, "parent_id": { "type": "integer", "format": "int64", "description": "The ID of the Comment that this comment is threaded under." } }, "required": [ "text" ] }, "description": "An array of comments to add to the story." }, "completed_at_override": { "type": "string", "description": "A manual override for the time/date the Story was completed." }, "created_at": { "type": "string", "description": "The time/date the Story was created." }, "custom_fields": { "type": "array", "items": { "type": "object", "properties": { "field_id": { "type": "string", "format": "uuid", "description": "The unique public ID for the CustomField." }, "value_id": { "type": "string", "format": "uuid", "description": "The unique public ID for the CustomFieldEnumValue." }, "value": { "type": "string", "description": "A literal value for the CustomField. Currently ignored." } }, "required": [ "field_id", "value_id" ] }, "description": "A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField." }, "custom_fields_add": { "type": "array", "items": { "type": "object", "properties": { "field_id": { "type": "string", "format": "uuid", "description": "The unique public ID for the CustomField." }, "value_id": { "type": "string", "format": "uuid", "description": "The unique public ID for the CustomFieldEnumValue." }, "value": { "type": "string", "description": "A literal value for the CustomField. Currently ignored." } }, "required": [ "field_id", "value_id" ] }, "description": "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`." }, "custom_fields_remove": { "type": "array", "items": { "type": "object", "properties": { "field_id": { "type": "string", "format": "uuid", "description": "The unique public ID for the CustomField." } }, "required": [ "field_id" ] }, "description": "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`." }, "deadline": { "type": [ "string", "null" ], "description": "The due date of the story." }, "description": { "type": "string", "description": "The description of the story." }, "epic_id": { "type": [ "integer", "null" ], "description": "The ID of the epic the story belongs to." }, "estimate": { "type": [ "integer", "null" ], "description": "The numeric point estimate of the story. Can also be null, which means unestimated." }, "external_id": { "type": "string", "description": "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." }, "external_links": { "type": "array", "items": { "type": "string" }, "description": "An array of External Links associated with this story." }, "external_links_add": { "type": "array", "items": { "type": "string" }, "description": "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`." }, "external_links_remove": { "type": "array", "items": { "type": "string" }, "description": "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`." }, "file_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "An array of IDs of files attached to the story." }, "file_ids_add": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "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`." }, "file_ids_remove": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "An array of IDs of files removed from files from the template. Cannot be used in conjunction with `file_ids`." }, "follower_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs of the followers of this story." }, "follower_ids_add": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The UUIDs of the new followers to be added in addition to followers from the template. Cannot be used in conjunction with `follower_ids.`" }, "follower_ids_remove": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The UUIDs of the new followers to be removed from followers from the template. Cannot be used in conjunction with `follower_ids`." }, "group_id": { "type": [ "string", "null" ], "description": "The id of the group to associate with this story." }, "iteration_id": { "type": [ "integer", "null" ], "description": "The ID of the iteration the story belongs to." }, "labels": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the new Label." }, "description": { "type": "string", "description": "The description of the new Label." }, "color": { "type": "string", "format": "css-color", "description": "The hex color to be displayed with the Label (for example, \"#ff0000\")." }, "external_id": { "type": "string", "description": "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." } }, "required": [ "name" ] }, "description": "An array of labels attached to the story." }, "labels_add": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the new Label." }, "description": { "type": "string", "description": "The description of the new Label." }, "color": { "type": "string", "format": "css-color", "description": "The hex color to be displayed with the Label (for example, \"#ff0000\")." }, "external_id": { "type": "string", "description": "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." } }, "required": [ "name" ] }, "description": "An array of labels attached to the story in addition to the labels provided by the template. Cannot be used in conjunction with `labels`." }, "labels_remove": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the new Label to remove." } }, "required": [ "name" ] }, "description": "An array of labels to remove from the labels provided by the template. Cannot be used in conjunction with `labels`." }, "linked_file_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "An array of IDs of linked files attached to the story." }, "linked_file_ids_add": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "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`." }, "linked_file_ids_remove": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "An array of IDs of linked files removed from files from the template. Cannot be used in conjunction with `linked_files.`" }, "move_to": { "type": "string", "description": "One of \"first\" or \"last\". This can be used to move the given story to the first or last position in the workflow state.", "enum": [ "last", "first" ] }, "name": { "type": "string", "description": "The name of the story. Must be provided if the template does not provide a name." }, "owner_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs of the owners of this story." }, "owner_ids_add": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The UUIDs of the new owners to be added in addition to owners from the template. Cannot be used in conjunction with `owners`." }, "owner_ids_remove": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The UUIDs of the new owners to be removed from owners from the template. Cannot be used in conjunction with `owners`." }, "parent_story_id": { "type": [ "integer", "null" ], "description": "The ID of the parent story to associate with this story (making the created story a sub-task). Field only applicable when Sub-task feature is enabled." }, "project_id": { "type": [ "integer", "null" ], "description": "The ID of the project the story belongs to." }, "requested_by_id": { "type": "string", "description": "The ID of the member that requested the story." }, "source_task_id": { "type": [ "integer", "null" ], "description": "Given this story was converted from a task in another story, this is the original task ID that was converted to this story." }, "started_at_override": { "type": "string", "description": "A manual override for the time/date the Story was started." }, "story_links": { "type": "array", "items": { "type": "object", "properties": { "subject_id": { "type": "integer", "format": "int64", "description": "The unique ID of the Story defined as subject." }, "verb": { "type": "string", "enum": [ "blocks", "duplicates", "relates to" ], "description": "How the subject Story acts on the object Story. This can be \"blocks\", \"duplicates\", or \"relates to\"." }, "object_id": { "type": "integer", "format": "int64", "description": "The unique ID of the Story defined as object." } }, "required": [ "verb" ] }, "description": "An array of story links attached to the story." }, "story_template_id": { "type": "string", "description": "The id of the story template used to create this story." }, "story_type": { "type": "string", "description": "The type of story (feature, bug, chore).", "enum": [ "feature", "chore", "bug" ] }, "sub_tasks": { "type": "array", "description": "An array of maps specifying sub-tasks to be associated with the created story. Each map can either link to an existing story or create a new sub-task story to be linked to the created story. Field only applicable when Sub-task feature is enabled." }, "tasks": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The Task description." }, "complete": { "type": "boolean", "description": "True/false boolean indicating whether the Task is completed. Defaults to false." }, "owner_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of UUIDs for any members you want to add as Owners on this new Task." }, "external_id": { "type": "string", "description": "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." }, "created_at": { "type": "string", "format": "date-time", "description": "Defaults to the time/date the Task is created but can be set to reflect another creation time/date." }, "updated_at": { "type": "string", "format": "date-time", "description": "Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date." } }, "required": [ "description" ] }, "description": "An array of tasks connected to the story." }, "updated_at": { "type": "string", "description": "The time/date the Story was updated." }, "workflow_state_id": { "type": "integer", "description": "The ID of the workflow state the story will be in." } }, "required": [ "PCID", "story_template_id" ] } ``` *** ## shortcut\_stories\_create\_story\_link Create Story Link **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ---------------------------- | | `object_id` | integer | Yes | — | The ID of the object Story. | | `subject_id` | integer | Yes | — | The ID of the subject Story. | | `verb` | string | Yes | — | The type of link. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object_id": { "type": "integer", "description": "The ID of the object Story." }, "subject_id": { "type": "integer", "description": "The ID of the subject Story." }, "verb": { "type": "string", "description": "The type of link.", "enum": [ "blocks", "duplicates", "relates to" ] } }, "required": [ "PCID", "object_id", "subject_id", "verb" ] } ``` *** ## shortcut\_stories\_create\_story\_reaction Create Story Reaction **Parameters:** | Parameter | Type | Required | Default | 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. | | `emoji` | string | Yes | — | The emoji short-code to add / remove. E.g. `:thumbsup::skin-tone-4:`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The ID of the Story that the Comment is in." }, "comment-public-id": { "type": "integer", "description": "The ID of the Comment." }, "emoji": { "type": "string", "description": "The emoji short-code to add / remove. E.g. `:thumbsup::skin-tone-4:`." } }, "required": [ "PCID", "story-public-id", "comment-public-id", "emoji" ] } ``` *** ## shortcut\_stories\_create\_task Create Task **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | `story-public-id` | integer | Yes | — | The ID of the Story that the Task will be in. | | `complete` | boolean | No | — | True/false boolean indicating whether the Task is completed. Defaults to false. | | `created_at` | string | No | — | Defaults to the time/date the Task is created but can be set to reflect another creation 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. | | `owner_ids` | string\[] | No | — | An array of UUIDs for any members you want to add as Owners on this new Task. | | `updated_at` | string | No | — | Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The ID of the Story that the Task will be in." }, "complete": { "type": "boolean", "description": "True/false boolean indicating whether the Task is completed. Defaults to false." }, "created_at": { "type": "string", "description": "Defaults to the time/date the Task is created but can be set to reflect another creation time/date." }, "description": { "type": "string", "description": "The Task description." }, "external_id": { "type": "string", "description": "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." }, "owner_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs for any members you want to add as Owners on this new Task." }, "updated_at": { "type": "string", "description": "Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date." } }, "required": [ "PCID", "story-public-id", "description" ] } ``` *** ## shortcut\_stories\_delete\_multiple\_stories Delete Multiple Stories **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ---------- | -------- | ------- | ------------------------------------- | | `story_ids` | integer\[] | Yes | — | An array of IDs of Stories to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "An array of IDs of Stories to delete." } }, "required": [ "PCID", "story_ids" ] } ``` *** ## shortcut\_stories\_delete\_story Delete Story **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | -------------------- | | `story-public-id` | integer | Yes | — | The ID of the Story. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The ID of the Story." } }, "required": [ "PCID", "story-public-id" ] } ``` *** ## shortcut\_stories\_delete\_story\_comment Delete Story Comment **Parameters:** | Parameter | Type | Required | Default | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The ID of the Story that the Comment is in." }, "comment-public-id": { "type": "integer", "description": "The ID of the Comment." } }, "required": [ "PCID", "story-public-id", "comment-public-id" ] } ``` *** ## shortcut\_stories\_delete\_story\_link Delete Story Link **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | -------------------------------- | | `story-link-public-id` | integer | Yes | — | The unique ID of the Story Link. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-link-public-id": { "type": "integer", "description": "The unique ID of the Story Link." } }, "required": [ "PCID", "story-link-public-id" ] } ``` *** ## shortcut\_stories\_delete\_story\_reaction Delete Story Reaction **Parameters:** | Parameter | Type | Required | Default | 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. | | `emoji` | string | Yes | — | The emoji short-code to add / remove. E.g. `:thumbsup::skin-tone-4:`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The ID of the Story that the Comment is in." }, "comment-public-id": { "type": "integer", "description": "The ID of the Comment." }, "emoji": { "type": "string", "description": "The emoji short-code to add / remove. E.g. `:thumbsup::skin-tone-4:`." } }, "required": [ "PCID", "story-public-id", "comment-public-id", "emoji" ] } ``` *** ## shortcut\_stories\_delete\_task Delete Task **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | -------------------------------------------------------- | | `story-public-id` | integer | Yes | — | The unique ID of the Story this Task is associated with. | | `task-public-id` | integer | Yes | — | The unique ID of the Task. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The unique ID of the Story this Task is associated with." }, "task-public-id": { "type": "integer", "description": "The unique ID of the Task." } }, "required": [ "PCID", "story-public-id", "task-public-id" ] } ``` *** ## shortcut\_stories\_get\_external\_link\_stories Get External Link Stories **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ------------------------------------------------------ | | `external_link` | string | Yes | — | The external link associated with one or more stories. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "external_link": { "type": "string", "description": "The external link associated with one or more stories." } }, "required": [ "PCID", "external_link" ] } ``` *** ## shortcut\_stories\_get\_story Get Story **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | -------------------- | | `story-public-id` | integer | Yes | — | The ID of the Story. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The ID of the Story." } }, "required": [ "PCID", "story-public-id" ] } ``` *** ## shortcut\_stories\_get\_story\_comment Get Story Comment **Parameters:** | Parameter | Type | Required | Default | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The ID of the Story that the Comment is in." }, "comment-public-id": { "type": "integer", "description": "The ID of the Comment." } }, "required": [ "PCID", "story-public-id", "comment-public-id" ] } ``` *** ## shortcut\_stories\_get\_story\_link Get Story Link **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | -------------------------------- | | `story-link-public-id` | integer | Yes | — | The unique ID of the Story Link. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-link-public-id": { "type": "integer", "description": "The unique ID of the Story Link." } }, "required": [ "PCID", "story-link-public-id" ] } ``` *** ## shortcut\_stories\_get\_task Get Task **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | -------------------------------------------------------- | | `story-public-id` | integer | Yes | — | The unique ID of the Story this Task is associated with. | | `task-public-id` | integer | Yes | — | The unique ID of the Task. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The unique ID of the Story this Task is associated with." }, "task-public-id": { "type": "integer", "description": "The unique ID of the Task." } }, "required": [ "PCID", "story-public-id", "task-public-id" ] } ``` *** ## shortcut\_stories\_list\_story\_comment List Story Comment **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------- | | `story-public-id` | integer | Yes | — | The ID of the Story that the Comment is in. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The ID of the Story that the Comment is in." } }, "required": [ "PCID", "story-public-id" ] } ``` *** ## shortcut\_stories\_list\_story\_sub\_tasks List Story Sub tasks **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | -------------------- | | `story-public-id` | integer | Yes | — | The ID of the Story. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The ID of the Story." } }, "required": [ "PCID", "story-public-id" ] } ``` *** ## shortcut\_stories\_query\_stories Query Stories **Parameters:** | Parameter | Type | Required | Default | Description | | | ---------------------- | ---------- | -------- | ------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------- | | `archived` | boolean | No | — | A true/false boolean indicating whether the Story is in archived state. | | | `completed_at_end` | string | No | — | Stories should have been completed on or before this date. | | | `completed_at_start` | string | No | — | Stories should have been completed on or after this date. | | | `created_at_end` | string | No | — | Stories should have been created on or before this date. | | | `created_at_start` | string | No | — | Stories should have been created on or after this date. | | | `deadline_end` | string | No | — | Stories should have a deadline on or before this date. | | | `deadline_start` | string | No | — | Stories should have a deadline on or after this date. | | | `epic_id` | integer | null | No | — | The Epic IDs that may be associated with the Stories. | | `epic_ids` | integer\[] | No | — | The Epic IDs that may be associated with the Stories. | | | `estimate` | integer | No | — | The number of estimate points associate with the Stories. | | | `external_id` | string | No | — | An ID or URL that references an external resource. Useful during imports. | | | `group_id` | string | null | No | — | The Group ID that is associated with the Stories | | `group_ids` | string\[] | No | — | The Group IDs that are associated with the Stories | | | `includes_description` | boolean | No | — | Whether to include the story description in the response. | | | `iteration_id` | integer | null | No | — | The Iteration ID that may be associated with the Stories. | | `iteration_ids` | integer\[] | No | — | The Iteration IDs that may be associated with the Stories. | | | `label_ids` | integer\[] | No | — | The Label IDs that may be associated with the Stories. | | | `label_name` | string | No | — | The name of any associated Labels. | | | `owner_id` | string | null | No | — | An array of UUIDs for any Users who may be Owners of the Stories. | | `owner_ids` | string\[] | No | — | An array of UUIDs for any Users who may be Owners of the Stories. | | | `project_id` | integer | null | No | — | The IDs for the Projects the Stories may be assigned to. | | `project_ids` | integer\[] | No | — | The IDs for the Projects the Stories may be assigned to. | | | `requested_by_id` | string | No | — | The UUID of any Users who may have requested the Stories. | | | `story_type` | string | No | — | The type of Stories that you want returned. | | | `updated_at_end` | string | No | — | Stories should have been updated on or before 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. | | | `workflow_state_types` | string\[] | No | — | The type of Workflow State the Stories may be in. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "archived": { "type": "boolean", "description": "A true/false boolean indicating whether the Story is in archived state." }, "completed_at_end": { "type": "string", "description": "Stories should have been completed on or before this date." }, "completed_at_start": { "type": "string", "description": "Stories should have been completed on or after this date." }, "created_at_end": { "type": "string", "description": "Stories should have been created on or before this date." }, "created_at_start": { "type": "string", "description": "Stories should have been created on or after this date." }, "deadline_end": { "type": "string", "description": "Stories should have a deadline on or before this date." }, "deadline_start": { "type": "string", "description": "Stories should have a deadline on or after this date." }, "epic_id": { "type": [ "integer", "null" ], "description": "The Epic IDs that may be associated with the Stories." }, "epic_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The Epic IDs that may be associated with the Stories." }, "estimate": { "type": "integer", "description": "The number of estimate points associate with the Stories." }, "external_id": { "type": "string", "description": "An ID or URL that references an external resource. Useful during imports." }, "group_id": { "type": [ "string", "null" ], "description": "The Group ID that is associated with the Stories" }, "group_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The Group IDs that are associated with the Stories" }, "includes_description": { "type": "boolean", "description": "Whether to include the story description in the response." }, "iteration_id": { "type": [ "integer", "null" ], "description": "The Iteration ID that may be associated with the Stories." }, "iteration_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The Iteration IDs that may be associated with the Stories." }, "label_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The Label IDs that may be associated with the Stories." }, "label_name": { "type": "string", "description": "The name of any associated Labels." }, "owner_id": { "type": [ "string", "null" ], "description": "An array of UUIDs for any Users who may be Owners of the Stories." }, "owner_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs for any Users who may be Owners of the Stories." }, "project_id": { "type": [ "integer", "null" ], "description": "The IDs for the Projects the Stories may be assigned to." }, "project_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The IDs for the Projects the Stories may be assigned to." }, "requested_by_id": { "type": "string", "description": "The UUID of any Users who may have requested the Stories." }, "story_type": { "type": "string", "description": "The type of Stories that you want returned.", "enum": [ "feature", "chore", "bug" ] }, "updated_at_end": { "type": "string", "description": "Stories should have been updated on or before this date." }, "updated_at_start": { "type": "string", "description": "Stories should have been updated on or after this date." }, "workflow_state_id": { "type": "integer", "description": "The unique IDs of the specific Workflow States that the Stories should be in." }, "workflow_state_types": { "type": "array", "items": { "type": "string", "enum": [ "started", "backlog", "unstarted", "done" ] }, "description": "The type of Workflow State the Stories may be in." } }, "required": [ "PCID" ] } ``` *** ## shortcut\_stories\_search Search **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `query` | string | Yes | — | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators) | | `page_size` | integer | No | — | The number of search results to include in a page. Minimum of 1 and maximum of 250. | | `detail` | string | 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". | | `next` | string | No | — | The next page token. | | `entity_types` | string\[] | No | — | A collection of entity\_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)" }, "page_size": { "type": "integer", "description": "The number of search results to include in a page. Minimum of 1 and maximum of 250." }, "detail": { "type": "string", "description": "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\".", "enum": [ "full", "slim" ] }, "next": { "type": "string", "description": "The next page token." }, "entity_types": { "type": "array", "items": { "type": "string", "enum": [ "story", "milestone", "epic", "iteration", "objective" ] }, "description": "A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story." } }, "required": [ "PCID", "query" ] } ``` *** ## shortcut\_stories\_search\_documents Search Documents **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------- | | `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. | | `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. | | `page_size` | integer | No | — | The number of search results to include in a page. Minimum of 1 and maximum of 250. | | `next` | string | No | — | The next page token. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "title": { "type": "string", "description": "Search text to match against document titles. Supports fuzzy matching. Required." }, "archived": { "type": "boolean", "description": "When true, find archived documents. When false, find non-archived documents." }, "created_by_me": { "type": "boolean", "description": "When true, find documents created by the current user. When false, find documents NOT created by current user." }, "followed_by_me": { "type": "boolean", "description": "When true, find documents that the current user is following. When false, find documents NOT followed." }, "page_size": { "type": "integer", "description": "The number of search results to include in a page. Minimum of 1 and maximum of 250." }, "next": { "type": "string", "description": "The next page token." } }, "required": [ "PCID", "title" ] } ``` *** ## shortcut\_stories\_search\_epics Search Epics **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `query` | string | Yes | — | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators) | | `page_size` | integer | No | — | The number of search results to include in a page. Minimum of 1 and maximum of 250. | | `detail` | string | 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". | | `next` | string | No | — | The next page token. | | `entity_types` | string\[] | No | — | A collection of entity\_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)" }, "page_size": { "type": "integer", "description": "The number of search results to include in a page. Minimum of 1 and maximum of 250." }, "detail": { "type": "string", "description": "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\".", "enum": [ "full", "slim" ] }, "next": { "type": "string", "description": "The next page token." }, "entity_types": { "type": "array", "items": { "type": "string", "enum": [ "story", "milestone", "epic", "iteration", "objective" ] }, "description": "A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story." } }, "required": [ "PCID", "query" ] } ``` *** ## shortcut\_stories\_search\_iterations Search Iterations **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `query` | string | Yes | — | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators) | | `page_size` | integer | No | — | The number of search results to include in a page. Minimum of 1 and maximum of 250. | | `detail` | string | 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". | | `next` | string | No | — | The next page token. | | `entity_types` | string\[] | No | — | A collection of entity\_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)" }, "page_size": { "type": "integer", "description": "The number of search results to include in a page. Minimum of 1 and maximum of 250." }, "detail": { "type": "string", "description": "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\".", "enum": [ "full", "slim" ] }, "next": { "type": "string", "description": "The next page token." }, "entity_types": { "type": "array", "items": { "type": "string", "enum": [ "story", "milestone", "epic", "iteration", "objective" ] }, "description": "A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story." } }, "required": [ "PCID", "query" ] } ``` *** ## shortcut\_stories\_search\_milestones Search Milestones **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `query` | string | Yes | — | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators) | | `page_size` | integer | No | — | The number of search results to include in a page. Minimum of 1 and maximum of 250. | | `detail` | string | 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". | | `next` | string | No | — | The next page token. | | `entity_types` | string\[] | No | — | A collection of entity\_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)" }, "page_size": { "type": "integer", "description": "The number of search results to include in a page. Minimum of 1 and maximum of 250." }, "detail": { "type": "string", "description": "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\".", "enum": [ "full", "slim" ] }, "next": { "type": "string", "description": "The next page token." }, "entity_types": { "type": "array", "items": { "type": "string", "enum": [ "story", "milestone", "epic", "iteration", "objective" ] }, "description": "A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story." } }, "required": [ "PCID", "query" ] } ``` *** ## shortcut\_stories\_search\_objectives Search Objectives **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `query` | string | Yes | — | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators) | | `page_size` | integer | No | — | The number of search results to include in a page. Minimum of 1 and maximum of 250. | | `detail` | string | 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". | | `next` | string | No | — | The next page token. | | `entity_types` | string\[] | No | — | A collection of entity\_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)" }, "page_size": { "type": "integer", "description": "The number of search results to include in a page. Minimum of 1 and maximum of 250." }, "detail": { "type": "string", "description": "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\".", "enum": [ "full", "slim" ] }, "next": { "type": "string", "description": "The next page token." }, "entity_types": { "type": "array", "items": { "type": "string", "enum": [ "story", "milestone", "epic", "iteration", "objective" ] }, "description": "A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story." } }, "required": [ "PCID", "query" ] } ``` *** ## shortcut\_stories\_search\_stories Search Stories **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `query` | string | Yes | — | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators) | | `page_size` | integer | No | — | The number of search results to include in a page. Minimum of 1 and maximum of 250. | | `detail` | string | 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". | | `next` | string | No | — | The next page token. | | `entity_types` | string\[] | No | — | A collection of entity\_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)" }, "page_size": { "type": "integer", "description": "The number of search results to include in a page. Minimum of 1 and maximum of 250." }, "detail": { "type": "string", "description": "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\".", "enum": [ "full", "slim" ] }, "next": { "type": "string", "description": "The next page token." }, "entity_types": { "type": "array", "items": { "type": "string", "enum": [ "story", "milestone", "epic", "iteration", "objective" ] }, "description": "A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story." } }, "required": [ "PCID", "query" ] } ``` *** ## shortcut\_stories\_story\_history Story History **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | -------------------- | | `story-public-id` | integer | Yes | — | The ID of the Story. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The ID of the Story." } }, "required": [ "PCID", "story-public-id" ] } ``` *** ## shortcut\_stories\_unlink\_comment\_thread\_from\_slack Unlink Comment thread from Slack **Parameters:** | Parameter | Type | Required | Default | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The ID of the Story to unlink." }, "comment-public-id": { "type": "integer", "description": "The ID of the Comment to unlink." } }, "required": [ "PCID", "story-public-id", "comment-public-id" ] } ``` *** ## shortcut\_stories\_update\_multiple\_stories Update Multiple Stories **Parameters:** | Parameter | Type | Required | Default | Description | | | ---------------------- | ---------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `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. | | | `before_id` | integer | No | — | The ID of the story that the stories are to be moved before. | | | `custom_fields_add` | object\[] | No | — | A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. | | | `custom_fields_remove` | object\[] | No | — | A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. | | | `deadline` | string | null | No | — | The due date of the story. | | `epic_id` | integer | null | No | — | The ID of the epic the story belongs to. | | `estimate` | integer | null | No | — | The numeric point estimate of the story. Can also be null, which means unestimated. | | `external_links` | string\[] | No | — | An array of External Links associated with this story. | | | `follower_ids_add` | string\[] | No | — | The UUIDs of the new followers to be added. | | | `follower_ids_remove` | string\[] | No | — | The UUIDs of the followers to be removed. | | | `group_id` | string | null | No | — | The Id of the Group the Stories should belong to. | | `iteration_id` | integer | null | No | — | The ID of the iteration the story belongs to. | | `labels_add` | object\[] | No | — | An array of labels to be added. | | | `labels_remove` | object\[] | No | — | An array of labels to be removed. | | | `move_to` | string | 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. | | | `owner_ids_add` | string\[] | No | — | The UUIDs of the new owners to be added. | | | `owner_ids_remove` | string\[] | No | — | The UUIDs of the owners to be removed. | | | `project_id` | integer | null | No | — | The ID of the Project the Stories should belong to. | | `requested_by_id` | string | No | — | The ID of the member that requested the story. | | | `story_ids` | integer\[] | Yes | — | The Ids of the Stories you wish to update. | | | `story_type` | string | No | — | The type of story (feature, bug, chore). | | | `workflow_state_id` | integer | No | — | The ID of the workflow state to put the stories in. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "after_id": { "type": "integer", "description": "The ID of the story that the stories are to be moved below." }, "archived": { "type": "boolean", "description": "If the Stories should be archived or not." }, "before_id": { "type": "integer", "description": "The ID of the story that the stories are to be moved before." }, "custom_fields_add": { "type": "array", "items": { "type": "object", "properties": { "field_id": { "type": "string", "format": "uuid", "description": "The unique public ID for the CustomField." }, "value_id": { "type": "string", "format": "uuid", "description": "The unique public ID for the CustomFieldEnumValue." }, "value": { "type": "string", "description": "A literal value for the CustomField. Currently ignored." } }, "required": [ "field_id", "value_id" ] }, "description": "A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField." }, "custom_fields_remove": { "type": "array", "items": { "type": "object", "properties": { "field_id": { "type": "string", "format": "uuid", "description": "The unique public ID for the CustomField." }, "value_id": { "type": "string", "format": "uuid", "description": "The unique public ID for the CustomFieldEnumValue." }, "value": { "type": "string", "description": "A literal value for the CustomField. Currently ignored." } }, "required": [ "field_id", "value_id" ] }, "description": "A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField." }, "deadline": { "type": [ "string", "null" ], "description": "The due date of the story." }, "epic_id": { "type": [ "integer", "null" ], "description": "The ID of the epic the story belongs to." }, "estimate": { "type": [ "integer", "null" ], "description": "The numeric point estimate of the story. Can also be null, which means unestimated." }, "external_links": { "type": "array", "items": { "type": "string" }, "description": "An array of External Links associated with this story." }, "follower_ids_add": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The UUIDs of the new followers to be added." }, "follower_ids_remove": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The UUIDs of the followers to be removed." }, "group_id": { "type": [ "string", "null" ], "description": "The Id of the Group the Stories should belong to." }, "iteration_id": { "type": [ "integer", "null" ], "description": "The ID of the iteration the story belongs to." }, "labels_add": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the new Label." }, "description": { "type": "string", "description": "The description of the new Label." }, "color": { "type": "string", "format": "css-color", "description": "The hex color to be displayed with the Label (for example, \"#ff0000\")." }, "external_id": { "type": "string", "description": "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." } }, "required": [ "name" ] }, "description": "An array of labels to be added." }, "labels_remove": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the new Label." }, "description": { "type": "string", "description": "The description of the new Label." }, "color": { "type": "string", "format": "css-color", "description": "The hex color to be displayed with the Label (for example, \"#ff0000\")." }, "external_id": { "type": "string", "description": "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." } }, "required": [ "name" ] }, "description": "An array of labels to be removed." }, "move_to": { "type": "string", "description": "One of \"first\" or \"last\". This can be used to move the given story to the first or last position in the workflow state.", "enum": [ "last", "first" ] }, "owner_ids_add": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The UUIDs of the new owners to be added." }, "owner_ids_remove": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The UUIDs of the owners to be removed." }, "project_id": { "type": [ "integer", "null" ], "description": "The ID of the Project the Stories should belong to." }, "requested_by_id": { "type": "string", "description": "The ID of the member that requested the story." }, "story_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The Ids of the Stories you wish to update." }, "story_type": { "type": "string", "description": "The type of story (feature, bug, chore).", "enum": [ "feature", "chore", "bug" ] }, "workflow_state_id": { "type": "integer", "description": "The ID of the workflow state to put the stories in." } }, "required": [ "PCID", "story_ids" ] } ``` *** ## shortcut\_stories\_update\_story Update Story **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `story-public-id` | integer | Yes | — | The unique identifier of this story. | | | `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. | | | `before_id` | integer | No | — | The ID of the story we want to move this story before. | | | `branch_ids` | integer\[] | No | — | An array of IDs of Branches attached to the story. | | | `commit_ids` | integer\[] | No | — | An array of IDs of Commits attached to the story. | | | `completed_at_override` | string | null | No | — | A manual override for the time/date the Story was completed. | | `custom_fields` | object\[] | No | — | A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. | | | `deadline` | string | null | No | — | The due date of the story. | | `description` | string | No | — | The description of the story. | | | `epic_id` | integer | null | No | — | The ID of the epic the story belongs to. | | `estimate` | integer | null | No | — | The numeric point estimate of the story. Can also be null, which means unestimated. | | `external_links` | string\[] | No | — | An array of External Links associated with this story. | | | `file_ids` | integer\[] | No | — | An array of IDs of files attached to the story. | | | `follower_ids` | string\[] | No | — | An array of UUIDs of the followers of this story. | | | `group_id` | string | null | No | — | The ID of the group to associate with this story | | `iteration_id` | integer | null | No | — | The ID of the iteration the story belongs to. | | `labels` | object\[] | No | — | An array of labels attached to the story. | | | `linked_file_ids` | integer\[] | No | — | An array of IDs of linked files attached to the story. | | | `move_to` | string | 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. | | | `name` | string | No | — | The title of the story. | | | `owner_ids` | string\[] | No | — | An array of UUIDs of the owners of this story. | | | `parent_story_id` | integer | null | No | — | The parent story id. If you want to unset this value set parent\_story\_id to null. | | `project_id` | integer | null | No | — | The ID of the project the story belongs to. | | `pull_request_ids` | integer\[] | No | — | An array of IDs of Pull/Merge Requests attached to the story. | | | `requested_by_id` | string | No | — | The ID of the member that requested the story. | | | `started_at_override` | string | null | No | — | A manual override for the time/date the Story was started. | | `story_type` | string | No | — | The type of story (feature, bug, chore). | | | `sub_tasks` | object\[] | No | — | An array of story IDs to attach to this story as sub-tasks. This list represents the final state of the parent's sub-tasks - missing stories will be unlinked, new stories will be linked, and the input order reflects sub-task positions. | | | `workflow_state_id` | integer | No | — | The ID of the workflow state to put the story in. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The unique identifier of this story." }, "after_id": { "type": "integer", "description": "The ID of the story we want to move this story after." }, "archived": { "type": "boolean", "description": "True if the story is archived, otherwise false." }, "before_id": { "type": "integer", "description": "The ID of the story we want to move this story before." }, "branch_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "An array of IDs of Branches attached to the story." }, "commit_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "An array of IDs of Commits attached to the story." }, "completed_at_override": { "type": [ "string", "null" ], "description": "A manual override for the time/date the Story was completed." }, "custom_fields": { "type": "array", "items": { "type": "object", "properties": { "field_id": { "type": "string", "format": "uuid", "description": "The unique public ID for the CustomField." }, "value_id": { "type": "string", "format": "uuid", "description": "The unique public ID for the CustomFieldEnumValue." }, "value": { "type": "string", "description": "A literal value for the CustomField. Currently ignored." } }, "required": [ "field_id", "value_id" ] }, "description": "A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField." }, "deadline": { "type": [ "string", "null" ], "description": "The due date of the story." }, "description": { "type": "string", "description": "The description of the story." }, "epic_id": { "type": [ "integer", "null" ], "description": "The ID of the epic the story belongs to." }, "estimate": { "type": [ "integer", "null" ], "description": "The numeric point estimate of the story. Can also be null, which means unestimated." }, "external_links": { "type": "array", "items": { "type": "string" }, "description": "An array of External Links associated with this story." }, "file_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "An array of IDs of files attached to the story." }, "follower_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs of the followers of this story." }, "group_id": { "type": [ "string", "null" ], "description": "The ID of the group to associate with this story" }, "iteration_id": { "type": [ "integer", "null" ], "description": "The ID of the iteration the story belongs to." }, "labels": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the new Label." }, "description": { "type": "string", "description": "The description of the new Label." }, "color": { "type": "string", "format": "css-color", "description": "The hex color to be displayed with the Label (for example, \"#ff0000\")." }, "external_id": { "type": "string", "description": "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." } }, "required": [ "name" ] }, "description": "An array of labels attached to the story." }, "linked_file_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "An array of IDs of linked files attached to the story." }, "move_to": { "type": "string", "description": "One of \"first\" or \"last\". This can be used to move the given story to the first or last position in the workflow state.", "enum": [ "last", "first" ] }, "name": { "type": "string", "description": "The title of the story." }, "owner_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs of the owners of this story." }, "parent_story_id": { "type": [ "integer", "null" ], "description": "The parent story id. If you want to unset this value set parent_story_id to null." }, "project_id": { "type": [ "integer", "null" ], "description": "The ID of the project the story belongs to." }, "pull_request_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "An array of IDs of Pull/Merge Requests attached to the story." }, "requested_by_id": { "type": "string", "description": "The ID of the member that requested the story." }, "started_at_override": { "type": [ "string", "null" ], "description": "A manual override for the time/date the Story was started." }, "story_type": { "type": "string", "description": "The type of story (feature, bug, chore).", "enum": [ "feature", "chore", "bug" ] }, "sub_tasks": { "type": "array", "items": { "type": "object", "properties": { "story_id": { "type": "integer", "format": "int64", "description": "The ID of the story to link as a sub-task of the parent story" } }, "required": [ "story_id" ] }, "description": "An array of story IDs to attach to this story as sub-tasks. This list represents the final state of the parent's sub-tasks - missing stories will be unlinked, new stories will be linked, and the input order reflects sub-task positions." }, "workflow_state_id": { "type": "integer", "description": "The ID of the workflow state to put the story in." } }, "required": [ "PCID", "story-public-id" ] } ``` *** ## shortcut\_stories\_update\_story\_comment Update Story Comment **Parameters:** | Parameter | Type | Required | Default | 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 | | `text` | string | Yes | — | The updated comment text. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The ID of the Story that the Comment is in." }, "comment-public-id": { "type": "integer", "description": "The ID of the Comment" }, "text": { "type": "string", "description": "The updated comment text." } }, "required": [ "PCID", "story-public-id", "comment-public-id", "text" ] } ``` *** ## shortcut\_stories\_update\_story\_link Update Story Link **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | -------------------------------- | | `story-link-public-id` | integer | Yes | — | The unique ID of the Story Link. | | `object_id` | integer | No | — | The ID of the object Story. | | `subject_id` | integer | No | — | The ID of the subject Story. | | `verb` | string | No | — | The type of link. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-link-public-id": { "type": "integer", "description": "The unique ID of the Story Link." }, "object_id": { "type": "integer", "description": "The ID of the object Story." }, "subject_id": { "type": "integer", "description": "The ID of the subject Story." }, "verb": { "type": "string", "description": "The type of link.", "enum": [ "blocks", "duplicates", "relates to" ] } }, "required": [ "PCID", "story-link-public-id" ] } ``` *** ## shortcut\_stories\_update\_task Update Task **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ------------------------------------------------------------- | | `story-public-id` | integer | Yes | — | The unique identifier of the parent Story. | | `task-public-id` | integer | Yes | — | The unique identifier of the Task you wish to update. | | `after_id` | integer | No | — | Move task after this task ID. | | `before_id` | integer | No | — | Move task before this task ID. | | `complete` | boolean | No | — | A true/false boolean indicating whether the task is complete. | | `description` | string | No | — | The Task's description. | | `owner_ids` | string\[] | No | — | An array of UUIDs of the owners of this story. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story-public-id": { "type": "integer", "description": "The unique identifier of the parent Story." }, "task-public-id": { "type": "integer", "description": "The unique identifier of the Task you wish to update." }, "after_id": { "type": "integer", "description": "Move task after this task ID." }, "before_id": { "type": "integer", "description": "Move task before this task ID." }, "complete": { "type": "boolean", "description": "A true/false boolean indicating whether the task is complete." }, "description": { "type": "string", "description": "The Task's description." }, "owner_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "An array of UUIDs of the owners of this story." } }, "required": [ "PCID", "story-public-id", "task-public-id" ] } ```