@shortcut/client
    Preparing search index...

    Interface UpdateEntityTemplateStoryContentsParams

    Updated attributes for the template to populate.

    interface UpdateEntityTemplateStoryContentsParams {
        custom_fields?: CreateCustomFieldValueParams[];
        custom_fields_add?: CreateCustomFieldValueParams[];
        custom_fields_remove?: CreateCustomFieldValueParams[];
        deadline?: string | null;
        description?: string;
        epic_id?: number | null;
        estimate?: number | null;
        external_links?: string[];
        external_links_add?: string[];
        external_links_remove?: string[];
        file_ids?: number[];
        file_ids_add?: number[];
        file_ids_remove?: number[];
        follower_ids?: string[];
        follower_ids_add?: string[];
        follower_ids_remove?: string[];
        group_id?: string | null;
        iteration_id?: number | null;
        label_ids?: number[];
        label_ids_add?: number[];
        label_ids_remove?: number[];
        linked_file_ids?: number[];
        linked_file_ids_add?: number[];
        linked_file_ids_remove?: number[];
        name?: string;
        owner_ids?: string[];
        owner_ids_add?: string[];
        owner_ids_remove?: string[];
        project_id?: number | null;
        story_type?: "feature" | "chore" | "bug";
        sub_tasks?: CreateEntityTemplateSubTaskParams[];
        tasks?: CreateEntityTemplateTaskParams[];
        workflow_state_id?: number | null;
    }
    Index

    Properties

    custom_fields? custom_fields_add? custom_fields_remove? deadline? description? epic_id? estimate? external_links? external_links_add? external_links_remove? file_ids? file_ids_add? file_ids_remove? follower_ids? follower_ids_add? follower_ids_remove? group_id? iteration_id? label_ids? label_ids_add? label_ids_remove? linked_file_ids? linked_file_ids_add? linked_file_ids_remove? name? owner_ids? owner_ids_add? owner_ids_remove? project_id? story_type? sub_tasks? tasks? workflow_state_id?

    Properties

    custom_fields?: CreateCustomFieldValueParams[]

    An array of CustomField value assertions to set on the template, replacing existing values.

    custom_fields_add?: CreateCustomFieldValueParams[]

    An array of CustomField value assertions to add to the template.

    custom_fields_remove?: CreateCustomFieldValueParams[]

    An array of CustomField value assertions to remove from the template.

    deadline?: string | null

    The due date of the story.

    date-time

    description?: string

    The description of the story.

    512

    epic_id?: number | null

    The ID of the epic to be populated.

    int64

    estimate?: number | null

    The numeric point estimate to be populated.

    int64

    external_links?: string[]

    An array of external links to set on the template, replacing existing links.

    external_links_add?: string[]

    An array of external links to add to the template.

    external_links_remove?: string[]

    An array of external links to remove from the template.

    file_ids?: number[]

    An array of file IDs to set on the template, replacing existing files.

    true

    file_ids_add?: number[]

    An array of file IDs to add to the template.

    true

    file_ids_remove?: number[]

    An array of file IDs to remove from the template.

    true

    follower_ids?: string[]

    An array of UUIDs for any Members you want to set as Followers, replacing existing Followers.

    follower_ids_add?: string[]

    An array of UUIDs for any Members you want to add as Followers.

    follower_ids_remove?: string[]

    An array of UUIDs for any Members you want to remove as Followers.

    group_id?: string | null

    The ID of the group to be populated.

    uuid

    iteration_id?: number | null

    The ID of the iteration to be populated.

    int64

    label_ids?: number[]

    An array of label IDs to set on the template, replacing existing labels.

    true

    label_ids_add?: number[]

    An array of label IDs to add to the template.

    true

    label_ids_remove?: number[]

    An array of label IDs to remove from the template.

    true

    linked_file_ids?: number[]

    An array of linked file IDs to set on the template, replacing existing linked files.

    true

    linked_file_ids_add?: number[]

    An array of linked file IDs to add to the template.

    true

    linked_file_ids_remove?: number[]

    An array of linked file IDs to remove from the template.

    true

    name?: string

    The name of the story.

    512

    owner_ids?: string[]

    An array of UUIDs for any Members you want to set as Owners, replacing existing Owners.

    owner_ids_add?: string[]

    An array of UUIDs for any Members you want to add as Owners.

    owner_ids_remove?: string[]

    An array of UUIDs for any Members you want to remove as Owners.

    project_id?: number | null

    The ID of the project the story belongs to.

    int64

    Optionalstory_type

    story_type?: "feature" | "chore" | "bug"

    The type of story (feature, bug, chore).

    sub_tasks?: CreateEntityTemplateSubTaskParams[]

    An array of sub-tasks to be populated by the template.

    tasks?: CreateEntityTemplateTaskParams[]

    An array of tasks to be populated by the template.

    workflow_state_id?: number | null

    The ID of the workflow state to be populated.

    int64

    Settings

    Member Visibility

    On This Page

    Properties