Create a new feature

POST

/api/initiatives/SHO-MJXR/features

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

Request

Header Params

Body Params application/json

Example

{
    "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
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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"
}

Modified at 2024-07-12 03:30:43

Removes the epic

Modify a feature