Create a new epic
POST
/api/initiatives/SHO-MJXR/epicsThe 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
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
features
array[string]
optional
estimate
string
optional
businessValue
string
optional
score
number
optional
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"
},
{
"url": "https://example.com"
},
{
"url": "https://example.com"
}
],
"jiraId": "",
"jiraKey": "",
"externalProgress": "",
"userStories": [],
"features": [],
"estimate": "60",
"businessValue": "100",
"score": 1.6666666666666667
}
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": "Enhance User Engagement and Retention",
"epicId": 1087,
"featureId": 0,
"type": "epic",
"cardId": 0,
"externalKey": "EP-41"
},
"message": "Epic saved"
}
Modified at 3 months ago