Modify an epic - Shorter Loop API Documentation

The POST /api/initiatives/SHO-MJXR/epics endpoint creates a new epic under the initiative identified by the external key SHO-MJXR. Epics are large bodies of work that can be broken down into smaller, manageable features or user stories.

Request

Query Params

Header Params

Body Params application/json

Example

{
    "summary": "Enhance User Engagement and Retention",
    "color": "#ffb64f",
    "progress": "in-progress",
    "backlog": false,
    "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"
        }
    ],
    "jiraId": "",
    "jiraKey": "",
    "externalProgress": "",
    "userStories": [],
    "features": [],
    "estimate": "60",
    "businessValue": "100",
    "kpis": [],
    "files": [
        {
            "file": {
                "id": 99141241,
                "path": "velit commodo Duis",
                "size": "amet",
                "sizeType": "magna ullamco nostrud",
                "userId": -25102660,
                "subscriptionId": 57218623,
                "initiativeId": 51716169,
                "usedAt": "2024-07-11T12:00:33.706Z",
                "description": null,
                "name": "excepturi consectetur commodi",
                "artifactId": 20573201,
                "status": "occaecat voluptate proident nisi do",
                "createdAt": "2024-07-11T20:13:24.087Z",
                "updatedAt": "2024-07-11T11:38:17.735Z",
                "file": "dolore Excepteur elit deserunt"
            }
        },
        {
            "file": {
                "id": 44976306,
                "path": "elit",
                "size": "laborum",
                "sizeType": "elit nulla ullamco",
                "userId": 60659579,
                "subscriptionId": -87990698,
                "initiativeId": 6223885,
                "usedAt": "2024-07-11T23:13:56.221Z",
                "description": null,
                "name": "harum amet laudantium",
                "artifactId": 21001770,
                "status": "ut irure Lorem",
                "createdAt": "2024-07-11T09:34:40.851Z",
                "updatedAt": "2024-07-11T06:42:36.877Z",
                "file": "occaecat"
            }
        },
        {
            "file": {
                "id": -34699907,
                "path": "in adipisicing ut fugiat occaecat",
                "size": "exercitation dolore",
                "sizeType": "ea",
                "userId": 8137860,
                "subscriptionId": -33521794,
                "initiativeId": 57811620,
                "usedAt": "2024-07-11T11:03:05.814Z",
                "description": null,
                "name": "nihil tempore dignissimos",
                "artifactId": 17871095,
                "status": "est aliqua laborum culpa voluptate",
                "createdAt": "2024-07-11T07:31:27.499Z",
                "updatedAt": "2024-07-11T12:05:19.067Z",
                "file": "adipisicing Ut nulla Duis in"
            }
        }
    ],
    "score": 1.6666666666666667
}

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/epics/EP-41?epicId=EP-41' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MjA3NSwiZmlyc3ROYW1lIjoiZGVlcGlrYSIsImxhc3ROYW1lIjpudWxsLCJ1c2VyRXhwZXJpZW5jZSI6bnVsbCwiZW1haWwiOiJkcGF0aWFsK2ppcmFAc2hvcnRlcmxvb3AuY29tIiwiZGlzcGxheU5hbWUiOiJkZWVwaWthIiwicHJvZmlsZUltYWdlIjoiMTM3OC9nZW5lcmFsL3VzZXJzL0lJM0YyMDc1YzZhNS5zdmciLCJ0aW1lWm9uZUFiYnIiOm51bGwsInN0YXR1cyI6ImFjdGl2ZSIsInByb3ZpZGVyIjoiY3VzdG9tIiwidGVybXNBY2NlcHRlZCI6MSwibGFzdFBhZ2UiOiIvQ09OT1AvcHJvZHVjdC9ERUUvZG9jdW1lbnRhdGlvbi91bnRpdGxlZC02LTY0ZjQiLCJ2ZXJpZmljYXRpb25Ub2tlbiI6IiIsImxhc3RTaWduSW4iOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJyb2xlIjoic3VwZXJhZG1pbiIsImlzUHJvZGVhc3lBZG1pbiI6MCwiZ3JvdXAiOjEsInJlZmVycmVyIjpudWxsLCJpc1ZlcmlmaWVkIjoxLCJyZWZlcnJlclRva2VuIjpudWxsLCJyZWZyZXNoUmVmZXJyZXJUb2tlbiI6bnVsbCwiYmlvIjpudWxsLCJjcmVhdGVkQXQiOiIyMDI1LTAzLTE3VDA5OjM2OjU2LjAwMFoiLCJ1cGRhdGVkQXQiOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJzdWJzY3JpcHRpb24iOnsidXNlclJvbGUiOiJzdXBlcmFkbWluIiwic3Vic2NyaXB0aW9uRXh0ZXJuYWxLZXkiOiJDT05PUCIsImV4dGVybmFsS2V5IjoiQ09OT1AiLCJjbmFtZSI6bnVsbCwiaWQiOjEzNzh9LCJzdWJzY3JpcHRpb25JZCI6MTM3OCwiZXh0ZXJuYWxLZXkiOiJDT05PUCIsInN1YnNjcmlwdGlvbkV4dGVybmFsS2V5IjoiQ09OT1AiLCJ0aW1lIjoiMjAyNS0wNC0wMlQwNTo0Mzo1NC41MDRaIiwiaWF0IjoxNzQzNTcyNjM0LCJleHAiOjE3NDM4MzE4MzR9.UJaUHpd_XJyGSv4C0DaaEVxDDQKzKZ_lKPkf8Yrr-Oc' \
--header 'initiativeId: DEE' \
--header 'Content-Type: application/json' \
--data-raw '{
    "summary": "Enhance User Engagement and Retention",
    "color": "#ffb64f",
    "progress": "in-progress",
    "backlog": false,
    "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"
        }
    ],
    "jiraId": "",
    "jiraKey": "",
    "externalProgress": "",
    "userStories": [],
    "features": [],
    "estimate": "60",
    "businessValue": "100",
    "kpis": [],
    "files": [
        {
            "file": {
                "id": 99141241,
                "path": "velit commodo Duis",
                "size": "amet",
                "sizeType": "magna ullamco nostrud",
                "userId": -25102660,
                "subscriptionId": 57218623,
                "initiativeId": 51716169,
                "usedAt": "2024-07-11T12:00:33.706Z",
                "description": null,
                "name": "excepturi consectetur commodi",
                "artifactId": 20573201,
                "status": "occaecat voluptate proident nisi do",
                "createdAt": "2024-07-11T20:13:24.087Z",
                "updatedAt": "2024-07-11T11:38:17.735Z",
                "file": "dolore Excepteur elit deserunt"
            }
        },
        {
            "file": {
                "id": 44976306,
                "path": "elit",
                "size": "laborum",
                "sizeType": "elit nulla ullamco",
                "userId": 60659579,
                "subscriptionId": -87990698,
                "initiativeId": 6223885,
                "usedAt": "2024-07-11T23:13:56.221Z",
                "description": null,
                "name": "harum amet laudantium",
                "artifactId": 21001770,
                "status": "ut irure Lorem",
                "createdAt": "2024-07-11T09:34:40.851Z",
                "updatedAt": "2024-07-11T06:42:36.877Z",
                "file": "occaecat"
            }
        },
        {
            "file": {
                "id": -34699907,
                "path": "in adipisicing ut fugiat occaecat",
                "size": "exercitation dolore",
                "sizeType": "ea",
                "userId": 8137860,
                "subscriptionId": -33521794,
                "initiativeId": 57811620,
                "usedAt": "2024-07-11T11:03:05.814Z",
                "description": null,
                "name": "nihil tempore dignissimos",
                "artifactId": 17871095,
                "status": "est aliqua laborum culpa voluptate",
                "createdAt": "2024-07-11T07:31:27.499Z",
                "updatedAt": "2024-07-11T12:05:19.067Z",
                "file": "adipisicing Ut nulla Duis in"
            }
        }
    ],
    "score": 1.6666666666666667
}'

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "data": {
        "summary": "Enhance User Engagement and Retention",
        "epicId": 1087,
        "featureId": 0,
        "type": "epic",
        "cardId": 0,
        "externalKey": "EP-41"
    },
    "message": "Epic saved"
}