Modify a feature - Shorter Loop API Documentation

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

Body Params application/json

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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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