Create a new feature
POST
/api/initiatives/SHO-MJXR/featuresThe POST /api/initiatives/SHO-MJXR/features endpoint creates a new feature under the initiative identified by the external key SHO-MJXR.
Request
Body Params application/json
summary
string
required
color
string
optional
progress
enum<string>
optional
Allowed values:
to-doin-progressdone
description
string
optional
businessGoal
string
optional
persona
array [object {2}]
optional
personaValue
string
required
personaId
integer
required
teamId
integer
optional
userId
array[integer]
optional
startDate
string
optional
endDate
string
optional
tags
string
optional
urls
array [object {1}]
optional
url
string
optional
jiraId
string
optional
jiraKey
string
optional
externalProgress
string
optional
userStories
array[string]
optional
estimate
string
optional
businessValue
string
optional
score
number
optional
epicId
number
required
Provide if feature is epic's child; otherwise omit.
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> </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 samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
success
boolean
required
data
object
optional
summary
string
required
epicId
integer
required
featureId
integer
required
type
string
required
cardId
integer
required
externalKey
string
required
message
string
optional
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 3 months ago