Create a new user story - Shorter Loop API Documentation

The POST /api/initiatives/SHO-MJXR/storyMap/card endpoint creates a new user story under the initiative identified by the external key SHO-MJXR.

Request

Header Params

Body Params application/json

Example

{
    "summary": "As a product manager, I want to implement personalized onboarding emails based on user behavior to improve user retention rates.",
    "color": "#4784fc",
    "progress": "to-do",
    "backlog": true,
    "description": "<ul><li><strong>Acceptance Criteria:</strong><ul><li>Develop a system to track user actions and behaviors within the first week of signup.</li><li>Design email templates that dynamically adjust content based on user activity.</li><li>Implement A/B testing for different email variants to optimize engagement.</li><li>Integrate analytics to measure the impact of personalized onboarding emails on user retention.</li></ul></li></ul><p>&nbsp;</p>",
    "businessGoal": "This user story aims to enhance user engagement and retention by leveraging personalized communication strategies.",
    "persona": [
        {
            "personaValue": "Product Managers (Strategy Oriented)",
            "personaId": 996
        }
    ],
    "teamId": 587,
    "userId": [],
    "startDate": "2024-06-30T18:30:00.000Z",
    "endDate": "2024-07-18T18:30:00.000Z",
    "tags": "[\"Product management\",\"engagement\"]",
    "urls": [
        {
            "url": "https://example.com"
        }
    ],
    "initiativeId": 0,
    "jiraId": "",
    "jiraKey": "",
    "externalProgress": "",
    "epicId": 0,
    "featureId": 0,
    "storyPoint": "7",
    "remainingTime": "3",
    "kpis": [],
    "score": 0
}

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/storyMap/card' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MjA3NSwiZmlyc3ROYW1lIjoiZGVlcGlrYSIsImxhc3ROYW1lIjpudWxsLCJ1c2VyRXhwZXJpZW5jZSI6bnVsbCwiZW1haWwiOiJkcGF0aWFsK2ppcmFAc2hvcnRlcmxvb3AuY29tIiwiZGlzcGxheU5hbWUiOiJkZWVwaWthIiwicHJvZmlsZUltYWdlIjoiMTM3OC9nZW5lcmFsL3VzZXJzL0lJM0YyMDc1YzZhNS5zdmciLCJ0aW1lWm9uZUFiYnIiOm51bGwsInN0YXR1cyI6ImFjdGl2ZSIsInByb3ZpZGVyIjoiY3VzdG9tIiwidGVybXNBY2NlcHRlZCI6MSwibGFzdFBhZ2UiOiIvQ09OT1AvcHJvZHVjdC9ERUUvZG9jdW1lbnRhdGlvbi91bnRpdGxlZC02LTY0ZjQiLCJ2ZXJpZmljYXRpb25Ub2tlbiI6IiIsImxhc3RTaWduSW4iOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJyb2xlIjoic3VwZXJhZG1pbiIsImlzUHJvZGVhc3lBZG1pbiI6MCwiZ3JvdXAiOjEsInJlZmVycmVyIjpudWxsLCJpc1ZlcmlmaWVkIjoxLCJyZWZlcnJlclRva2VuIjpudWxsLCJyZWZyZXNoUmVmZXJyZXJUb2tlbiI6bnVsbCwiYmlvIjpudWxsLCJjcmVhdGVkQXQiOiIyMDI1LTAzLTE3VDA5OjM2OjU2LjAwMFoiLCJ1cGRhdGVkQXQiOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJzdWJzY3JpcHRpb24iOnsidXNlclJvbGUiOiJzdXBlcmFkbWluIiwic3Vic2NyaXB0aW9uRXh0ZXJuYWxLZXkiOiJDT05PUCIsImV4dGVybmFsS2V5IjoiQ09OT1AiLCJjbmFtZSI6bnVsbCwiaWQiOjEzNzh9LCJzdWJzY3JpcHRpb25JZCI6MTM3OCwiZXh0ZXJuYWxLZXkiOiJDT05PUCIsInN1YnNjcmlwdGlvbkV4dGVybmFsS2V5IjoiQ09OT1AiLCJ0aW1lIjoiMjAyNS0wNC0wMlQwNTo0Mzo1NC41MDRaIiwiaWF0IjoxNzQzNTcyNjM0LCJleHAiOjE3NDM4MzE4MzR9.UJaUHpd_XJyGSv4C0DaaEVxDDQKzKZ_lKPkf8Yrr-Oc' \
--header 'initiativeId: DEE' \
--header 'Content-Type: application/json' \
--data-raw '{
    "summary": "As a product manager, I want to implement personalized onboarding emails based on user behavior to improve user retention rates.",
    "color": "#4784fc",
    "progress": "to-do",
    "backlog": true,
    "description": "<ul><li><strong>Acceptance Criteria:</strong><ul><li>Develop a system to track user actions and behaviors within the first week of signup.</li><li>Design email templates that dynamically adjust content based on user activity.</li><li>Implement A/B testing for different email variants to optimize engagement.</li><li>Integrate analytics to measure the impact of personalized onboarding emails on user retention.</li></ul></li></ul><p>&nbsp;</p>",
    "businessGoal": "This user story aims to enhance user engagement and retention by leveraging personalized communication strategies.",
    "persona": [
        {
            "personaValue": "Product Managers (Strategy Oriented)",
            "personaId": 996
        }
    ],
    "teamId": 587,
    "userId": [],
    "startDate": "2024-06-30T18:30:00.000Z",
    "endDate": "2024-07-18T18:30:00.000Z",
    "tags": "[\"Product management\",\"engagement\"]",
    "urls": [
        {
            "url": "https://example.com"
        }
    ],
    "initiativeId": 0,
    "jiraId": "",
    "jiraKey": "",
    "externalProgress": "",
    "epicId": 0,
    "featureId": 0,
    "storyPoint": "7",
    "remainingTime": "3",
    "kpis": [],
    "score": 0
}'

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "message": "Card has been created.",
    "data": {
        "stroyMapCardId": 1238,
        "externalKey": "US-19",
        "metaData": {
            "persona": [
                {
                    "personaValue": "Product Managers (Strategy Oriented)",
                    "personaId": 996
                },
                {
                    "personaValue": "Startup founders",
                    "personaId": 997
                }
            ],
            "urls": [
                {
                    "url": "https://example.com"
                }
            ],
            "id": 1238,
            "userId": [
                17355
            ],
            "description": "<ul><li><strong>Acceptance Criteria:</strong><ul><li>Develop a system to track user actions and behaviors within the first week of signup.</li><li>Design email templates that dynamically adjust content based on user activity.</li><li>Implement A/B testing for different email variants to optimize engagement.</li><li>Integrate analytics to measure the impact of personalized onboarding emails on user retention.</li></ul></li></ul><p>&nbsp;</p>",
            "detail": null,
            "order": 0,
            "color": "#4784fc",
            "externalKey": "US-19",
            "initiativeId": "1116",
            "teamId": 587,
            "status": "active",
            "summary": "As a product manager, I want to implement personalized onboarding emails based on user behavior to improve user retention rates.",
            "backlog": true,
            "featureId": 0,
            "epicId": 0,
            "progress": "to-do",
            "externalProgress": "",
            "tags": "[\"Product management\",\"engagement\"]",
            "timeBoxPlanningId": 0,
            "businessObjectiveId": 0,
            "businessGoal": "This user story aims to enhance user engagement and retention by leveraging personalized communication strategies.",
            "dueDate": null,
            "remainingTime": "3.00",
            "storyPoint": 7,
            "jiraId": "",
            "jiraKey": "",
            "jiraSelf": null,
            "jiraParentId": "",
            "startDate": "2024-06-30T18:30:00.000Z",
            "endDate": "2024-07-18T18:30:00.000Z",
            "storyMapId": 0,
            "createdAt": "2024-07-12T03:39:35.000Z",
            "updatedAt": "2024-07-12T03:39:35.000Z"
        }
    }
}