Shorter Loop API Documentation
  1. Backlog Management
  2. Features
Shorter Loop API Documentation
  • Getting started
    • Welcome to the Shorter Loop API Portal
    • Authentication
    • Base URL
  • Metrics
    • Create a Key Performance Indicator (KPI)
      POST
    • Update the Key Performance Indicator (KPI)
      PUT
    • Retrieve KPIs not linked to specific product backlog items
      GET
    • Insert KPI's records (Body JSON Payload)
      POST
    • Insert KPI's records (Upload CSV)
      POST
    • Insert KPI's records (Upload JSON)
      POST
  • Idea manager
    • Feedback Collection
      • Create idea and issue
      • Retrieves a list of categories
      • Modify feedback item
      • Removes a feedback item
      • Upvote or downvote a work item
      • Retrieve a feedback item
      • Get comments for a feedback item.
      • Reply to a comment
      • Modify a comment
      • Bulk create feedback items: CSV and JSON
    • Segments
      • Retrieves a list of segments without users
      • Create segment
      • Modify a segment
      • Removes a segment
      • Bulk create users to a segment
      • Manage user segments: move or remove
      • Retrieve segments with users
      • Retrieve segment with users
      • Import Users (CSV/JSON)
      • Sending email to segment members
      • Sending email to selected idm members
    • Bulk create idea manager members
      POST
    • Import Users (CSV/JSON) in IDM
      POST
    • Bulk re-invite in IDM
      PUT
  • Backlog Management
    • Epics
      • Create a new epic
      • Modify an epic
      • Retrieve details of the epic
      • Removes the epic
    • Features
      • Create a new feature
        POST
      • Modify a feature
        PUT
      • Retrieve details of the feature
        GET
      • Removes the feature
        DELETE
    • User stories
      • Create a new user story
      • Modify a user story
      • Retrieve user story
      • Removes the user story
    • Assets
      • Attaches files to the workitem
      • Removes an asset
      • Retrieve attachments for the backlog workitem with ID
    • Product Tags
      • Retrieves tags for initiative
    • Teams
      • Get teams and members for product
    • Personas
      • Retrieve personas associated with initiative
    • Get whole backlog tree
      GET
  • Strategy Board
    • Experiment
      • Create a new experiemnt variant
    • Solutions
      • Versions
        • Storymap versions api documentation
        • Create a version
        • Update version
        • Removes a version
        • Retrieve versions
      • Get all storymaps for solution
  • Persona Board V2
    • Segments
      • Permanently deletes a segment
      • Creates a new option
      • Retrieve a list of segments
      • Retrieve a segment
      • Create a segment
      • Removes a segment
      • Removes a segment option
      • Detaches a segment from the persona
      • Update segment option
    • Custom fields
      • Removes a custom field
      • Retrieve a list of custom fields
      • Retrieve a custom field
      • Create a custom field
      • Removes a custom field option
      • Detaches a custom field from persona
      • Retrieve custom fields excluding persona
      • Creates a new option
      • Permanently deletes a custom field
      • Update custom field
      • Update custom field option
      • Attach a custom field to a persona
    • Create opportunities from summary
    • Retrieve notes
    • Retrieve persona
    • Retrieve experiments for Persona
    • Create
    • Retrieve
  • DocsHub
    • Retrieve categories with templates
    • Retrieve a template based on category
    • Create copy of template while using template
  1. Backlog Management
  2. Features

Modify a feature

PUT
/api/initiatives/SHO-MJXR/features/FE-75
The POST /api/initiatives/SHO-MJXR/epics endpoint creates a new feature under the initiative identified by the external key SHO-MJXR.

Request

Header Params
Authorization
string 
required
Default:
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MjA3NSwiZmlyc3ROYW1lIjoiZGVlcGlrYSIsImxhc3ROYW1lIjpudWxsLCJ1c2VyRXhwZXJpZW5jZSI6bnVsbCwiZW1haWwiOiJkcGF0aWFsK2ppcmFAc2hvcnRlcmxvb3AuY29tIiwiZGlzcGxheU5hbWUiOiJkZWVwaWthIiwicHJvZmlsZUltYWdlIjoiMTM3OC9nZW5lcmFsL3VzZXJzL0lJM0YyMDc1YzZhNS5zdmciLCJ0aW1lWm9uZUFiYnIiOm51bGwsInN0YXR1cyI6ImFjdGl2ZSIsInByb3ZpZGVyIjoiY3VzdG9tIiwidGVybXNBY2NlcHRlZCI6MSwibGFzdFBhZ2UiOiIvQ09OT1AvcHJvZHVjdC9ERUUvZG9jdW1lbnRhdGlvbi91bnRpdGxlZC02LTY0ZjQiLCJ2ZXJpZmljYXRpb25Ub2tlbiI6IiIsImxhc3RTaWduSW4iOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJyb2xlIjoic3VwZXJhZG1pbiIsImlzUHJvZGVhc3lBZG1pbiI6MCwiZ3JvdXAiOjEsInJlZmVycmVyIjpudWxsLCJpc1ZlcmlmaWVkIjoxLCJyZWZlcnJlclRva2VuIjpudWxsLCJyZWZyZXNoUmVmZXJyZXJUb2tlbiI6bnVsbCwiYmlvIjpudWxsLCJjcmVhdGVkQXQiOiIyMDI1LTAzLTE3VDA5OjM2OjU2LjAwMFoiLCJ1cGRhdGVkQXQiOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJzdWJzY3JpcHRpb24iOnsidXNlclJvbGUiOiJzdXBlcmFkbWluIiwic3Vic2NyaXB0aW9uRXh0ZXJuYWxLZXkiOiJDT05PUCIsImV4dGVybmFsS2V5IjoiQ09OT1AiLCJjbmFtZSI6bnVsbCwiaWQiOjEzNzh9LCJzdWJzY3JpcHRpb25JZCI6MTM3OCwiZXh0ZXJuYWxLZXkiOiJDT05PUCIsInN1YnNjcmlwdGlvbkV4dGVybmFsS2V5IjoiQ09OT1AiLCJ0aW1lIjoiMjAyNS0wNC0wMlQwNTo0Mzo1NC41MDRaIiwiaWF0IjoxNzQzNTcyNjM0LCJleHAiOjE3NDM4MzE4MzR9.UJaUHpd_XJyGSv4C0DaaEVxDDQKzKZ_lKPkf8Yrr-Oc
initiativeId
string 
required
How to get initiativeId:
Visit https://app.shorterloop.com/ACME/product/SHO-MJXR/dashboard.
The initiativeId is SHO-MJXR in the URL.
Use this initiativeId in the initiativeId header for API requests.
Default:
DEE
Example:
MGMT
Content-Type
string 
required
Default:
application/json
Body Params application/json
summary
string 
optional
color
string 
optional
progress
string 
optional
backlog
boolean 
optional
description
string 
optional
businessGoal
string 
optional
persona
array [object {2}] 
optional
personaValue
string 
optional
personaId
integer 
optional
teamId
null 
optional
userId
array[integer]
optional
startDate
string 
optional
endDate
string 
optional
tags
string 
optional
urls
array [object {1}] 
optional
url
string 
optional
jiraId
string 
optional
jiraKey
string 
optional
externalProgress
string 
optional
userStories
array[string]
optional
estimate
string 
optional
businessValue
string 
optional
kpis
array[string]
optional
files
array [object {1}] 
optional
file
object 
optional
score
number 
optional
epicId
integer 
optional
Provide if feature is epic's child; otherwise omit
Example
{
  "summary": "Enhance User Engagement and Retention",
  "color": "#ffb64f",
  "progress": "in-progress",
  "backlog": true,
  "description": "<p>Improve user engagement and retention metrics through targeted feature enhancements and optimizations across the platform.</p><p>&nbsp;</p>",
  "businessGoal": "Increase Monthly Active Users (MAUs) by 20% within the next fiscal year.",
  "persona": [
    {
      "personaValue": "UX Researchers",
      "personaId": 999
    },
    {
      "personaValue": "UX Researchers",
      "personaId": 999
    }
  ],
  "teamId": null,
  "userId": [],
  "startDate": "2024-06-30T18:30:00.000Z",
  "endDate": "2024-07-30T18:30:00.000Z",
  "tags": "[\"Epic\",\"User engagement\"]",
  "urls": [
    {
      "url": "https://example.com"
    },
    {
      "url": "https://example.com"
    },
    {
      "url": "https://example.com"
    }
  ],
  "jiraId": "",
  "jiraKey": "",
  "externalProgress": "",
  "userStories": [],
  "estimate": "60",
  "businessValue": "100",
  "kpis": [],
  "files": [
    {
      "file": {
        "id": -3829435,
        "path": "veniam non sunt officia eiusmod",
        "size": "eu dolore incididunt nostrud dolor",
        "sizeType": "exercitation deserunt commodo in culpa",
        "userId": -92850400,
        "subscriptionId": -9864495,
        "initiativeId": -13546918,
        "usedAt": "2024-07-11T19:16:22.477Z",
        "description": null,
        "name": "sapiente consequatur odit",
        "artifactId": -27561444,
        "status": "minim aute",
        "createdAt": "2024-07-11T07:29:05.378Z",
        "updatedAt": "2024-07-11T14:19:35.935Z",
        "file": "cillum dolore"
      }
    },
    {
      "file": {
        "id": -52227059,
        "path": "Ut dolore veniam",
        "size": "officia commodo sed culpa exercitation",
        "sizeType": "adipisicing enim cupidatat",
        "userId": -14844715,
        "subscriptionId": 94541449,
        "initiativeId": -1742508,
        "usedAt": "2024-07-11T03:59:58.538Z",
        "description": null,
        "name": "ipsum officia fuga",
        "artifactId": 66552059,
        "status": "anim Lorem qui reprehenderit",
        "createdAt": "2024-07-11T22:23:22.584Z",
        "updatedAt": "2024-07-12T00:41:56.560Z",
        "file": "sunt culpa sit eiusmod officia"
      }
    },
    {
      "file": {
        "id": -32286563,
        "path": "eiusmod",
        "size": "dolore ad elit labore",
        "sizeType": "laboris dolore in",
        "userId": -80237071,
        "subscriptionId": -99262436,
        "initiativeId": -66981550,
        "usedAt": "2024-07-11T09:19:39.699Z",
        "description": null,
        "name": "cumque architecto minima",
        "artifactId": -49899831,
        "status": "sit deserunt ullamco reprehenderit",
        "createdAt": "2024-07-11T04:56:09.618Z",
        "updatedAt": "2024-07-11T11:03:53.708Z",
        "file": "fugiat in nulla deserunt"
      }
    }
  ],
  "score": 1.6666666666666667,
  "epicId": -7355381
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.shorterloop.com/api/initiatives/SHO-MJXR/features/FE-75' \
--header 'Authorization;' \
--header 'initiativeId;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "summary": "Enhance User Engagement and Retention",
    "color": "#ffb64f",
    "progress": "in-progress",
    "backlog": true,
    "description": "<p>Improve user engagement and retention metrics through targeted feature enhancements and optimizations across the platform.</p><p>&nbsp;</p>",
    "businessGoal": "Increase Monthly Active Users (MAUs) by 20% within the next fiscal year.",
    "persona": [
        {
            "personaValue": "UX Researchers",
            "personaId": 999
        },
        {
            "personaValue": "UX Researchers",
            "personaId": 999
        }
    ],
    "teamId": null,
    "userId": [],
    "startDate": "2024-06-30T18:30:00.000Z",
    "endDate": "2024-07-30T18:30:00.000Z",
    "tags": "[\"Epic\",\"User engagement\"]",
    "urls": [
        {
            "url": "https://example.com"
        },
        {
            "url": "https://example.com"
        },
        {
            "url": "https://example.com"
        }
    ],
    "jiraId": "",
    "jiraKey": "",
    "externalProgress": "",
    "userStories": [],
    "estimate": "60",
    "businessValue": "100",
    "kpis": [],
    "files": [
        {
            "file": {
                "id": -3829435,
                "path": "veniam non sunt officia eiusmod",
                "size": "eu dolore incididunt nostrud dolor",
                "sizeType": "exercitation deserunt commodo in culpa",
                "userId": -92850400,
                "subscriptionId": -9864495,
                "initiativeId": -13546918,
                "usedAt": "2024-07-11T19:16:22.477Z",
                "description": null,
                "name": "sapiente consequatur odit",
                "artifactId": -27561444,
                "status": "minim aute",
                "createdAt": "2024-07-11T07:29:05.378Z",
                "updatedAt": "2024-07-11T14:19:35.935Z",
                "file": "cillum dolore"
            }
        },
        {
            "file": {
                "id": -52227059,
                "path": "Ut dolore veniam",
                "size": "officia commodo sed culpa exercitation",
                "sizeType": "adipisicing enim cupidatat",
                "userId": -14844715,
                "subscriptionId": 94541449,
                "initiativeId": -1742508,
                "usedAt": "2024-07-11T03:59:58.538Z",
                "description": null,
                "name": "ipsum officia fuga",
                "artifactId": 66552059,
                "status": "anim Lorem qui reprehenderit",
                "createdAt": "2024-07-11T22:23:22.584Z",
                "updatedAt": "2024-07-12T00:41:56.560Z",
                "file": "sunt culpa sit eiusmod officia"
            }
        },
        {
            "file": {
                "id": -32286563,
                "path": "eiusmod",
                "size": "dolore ad elit labore",
                "sizeType": "laboris dolore in",
                "userId": -80237071,
                "subscriptionId": -99262436,
                "initiativeId": -66981550,
                "usedAt": "2024-07-11T09:19:39.699Z",
                "description": null,
                "name": "cumque architecto minima",
                "artifactId": -49899831,
                "status": "sit deserunt ullamco reprehenderit",
                "createdAt": "2024-07-11T04:56:09.618Z",
                "updatedAt": "2024-07-11T11:03:53.708Z",
                "file": "fugiat in nulla deserunt"
            }
        }
    ],
    "score": 1.6666666666666667,
    "epicId": -7355381
}'

Responses

🟢200Success
application/json
Body
success
boolean 
optional
message
string 
optional
data
object 
optional
id
integer 
optional
summary
string 
optional
externalKey
string 
optional
color
string 
optional
progress
string 
optional
backlog
boolean 
optional
description
string 
optional
businessGoal
string 
optional
persona
array [object {2}] 
optional
teamId
null 
optional
userId
string 
optional
startDate
string 
optional
endDate
string 
optional
tags
string 
optional
urls
array [object {1}] 
optional
jiraId
string 
optional
jiraKey
string 
optional
externalProgress
string 
optional
estimate
string 
optional
businessValue
string 
optional
userStories
array[string]
optional
kpis
array[string]
optional
score
number 
optional
Example
{
  "success": true,
  "message": "Feature is updated.",
  "data": {
    "id": 1643,
    "summary": "User Engagement Dashboard.",
    "externalKey": "FE-75",
    "color": "#4784fc",
    "progress": "to-do",
    "backlog": true,
    "description": "<p>Develop a dashboard to track user retention metrics, including active users, retention rates, and engagement trends over time.</p>",
    "businessGoal": "Improve insights into user behavior to enhance retention strategies and user satisfaction.",
    "persona": [
      {
        "personaValue": "Product Owners (Execution Oriented)",
        "personaId": 998
      },
      {
        "personaValue": "UX Researchers",
        "personaId": 999
      }
    ],
    "teamId": null,
    "userId": "[17355]",
    "startDate": "2024-07-12T18:30:00.000Z",
    "endDate": "2024-07-18T18:30:00.000Z",
    "tags": "[\"engagement\",\"Product management\"]",
    "urls": [
      {
        "url": "https://example.com"
      }
    ],
    "jiraId": "",
    "jiraKey": "",
    "externalProgress": "",
    "epicId": 0,
    "estimate": "60",
    "businessValue": "80",
    "userStories": [],
    "kpis": [],
    "type": "feature",
    "progressPercentage": 0,
    "firstChild": "userStories",
    "score": 1.3333333333333333,
    "goalDescription": "",
    "featureId": 0
  }
}
Modified at 2024-07-15 04:49:03
Previous
Create a new feature
Next
Retrieve details of the feature
Built with