Create a new user story
POST
/api/initiatives/SHO-MJXR/storyMap/cardThe POST /api/initiatives/SHO-MJXR/storyMap/card endpoint creates a new user story under the initiative identified by the external key SHO-MJXR.
Request
Body Params application/json
summary
string
optional
color
string
optional
progress
string
optional
backlog
boolean
optional
description
string
optional
businessGoal
string
optional
persona
array [object {2}]
optional
personaValue
string
optional
personaId
integer
optional
teamId
integer
optional
userId
array[integer]
optional
startDate
string
optional
endDate
string
optional
tags
string
optional
urls
array [object {1}]
optional
url
string
optional
initiativeId
integer
optional
jiraId
string
optional
jiraKey
string
optional
externalProgress
string
optional
epicId
integer
optional
Provide it to make userstory child of epic
featureId
integer
optional
Provide it to make userstory child of feature
storyPoint
string
optional
remainingTime
string
optional
kpis
array[string]
optional
score
integer
optional
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> </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 samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
success
boolean
required
message
string
required
data
object
required
stroyMapCardId
integer
required
externalKey
string
required
metaData
object
required
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> </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"
}
}
}
Modified at 3 months ago