Create a new feature - Shorter Loop API Documentation

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

required

color

string

optional

progress

enum<string>

optional

Allowed values:

to-doin-progressdone

description

string

optional

businessGoal

string

optional

persona

array [object {2}]

optional

personaValue

string

required

personaId

integer

required

teamId

integer

optional

userId

array[integer]

optional

startDate

string

optional

endDate

string

optional

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.shorterloop.com/api/initiatives/SHO-MJXR/features' \
--header 'Authorization;' \
--header 'initiativeId;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "summary": "Enhance User Engagement and Retention",
    "color": "#ffb64f",
    "progress": "in-progress",
    "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": 587,
    "userId": [],
    "startDate": "2024-06-30T18:30:00.000Z",
    "endDate": "2024-07-30T18:30:00.000Z",
    "tags": "[\"Epic\",\"User engagement\"]",
    "urls": [
        {
            "url": "https://example.com"
        }
    ],
    "jiraId": "",
    "jiraKey": "",
    "externalProgress": "",
    "userStories": [],
    "estimate": "60",
    "businessValue": "100",
    "score": 1.6666666666666667,
    "epicId": 46633902.814527154
}'

Responses

🟢200Success

application/json

Body

success

boolean

required

data

object

optional

summary

string

required

epicId

integer

required

featureId

integer

required

type

string

required

cardId

integer

required

externalKey

string

required

message

string

optional

Example

{
  "success": true,
  "data": {
    "summary": "User Engagement Dashboard",
    "featureId": 1643,
    "epicId": 0,
    "type": "impact_map",
    "externalKey": "FE-75",
    "metaData": {
      "persona": [
        {
          "personaValue": "Product Owners (Execution Oriented)",
          "personaId": 998
        },
        {
          "personaValue": "UX Researchers",
          "personaId": 999
        }
      ],
      "urls": [
        {
          "url": "https://example.com"
        }
      ],
      "id": 1643,
      "summary": "User Engagement Dashboard",
      "userId": "[17355]",
      "backlog": true,
      "description": "<p>Develop a dashboard to track user retention metrics, including active users, retention rates, and engagement trends over time.</p>",
      "successCriteria": null,
      "nonFunctionalRequirements": null,
      "initiativeId": "1116",
      "teamId": 587,
      "externalKey": "FE-75",
      "status": "active",
      "detail": null,
      "color": "#4784fc",
      "order": null,
      "score": "1.3333333333333333",
      "startDate": "2024-07-12T18:30:00.000Z",
      "endDate": "2024-07-18T18:30:00.000Z",
      "epicId": 0,
      "estimate": "60",
      "progress": "to-do",
      "externalProgress": "",
      "businessValue": "80",
      "tags": "\"[{\"key\":\"engagement\",\"slug\":\"engagement\"},{\"key\":\"Product management\",\"slug\":\"product-management\"}]\"",
      "timeBoxPlanningId": 0,
      "subTimeBoxPlanningId": 0,
      "swimlaneId": 0,
      "roadmapId": 0,
      "storyMapId": 0,
      "businessObjectiveId": 0,
      "businessGoal": "Improve insights into user behavior to enhance retention strategies and user satisfaction.",
      "jiraId": "",
      "jiraKey": "",
      "jiraSelf": null,
      "jiraParentId": "",
      "createdAt": "2024-07-12T03:15:56.000Z",
      "updatedAt": "2024-07-12T03:15:56.000Z"
    }
  },
  "message": "Feature saved"
}