Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

How to write a good description using jira rest api

Prateek Vyas February 12, 2025

Hi i want to write a good description using heading and bullet list using JIRA REST API.
But i didn't get any example in the documentation like how i can use heading etc. 

Right now i am sending this payload in the api.


{
"fields": {
"labels": [
"new_release"
],
"components": [
{
"id": "28802"
}
],
"duedate": "2026-03-03",
"priority": {
"name": "Low"
},
"description": {
"content": [
{
"content": [
{
"text": "what is the project about?",
"type": "text"
}
],
"type": "paragraph"
}
],
"type": "doc",
"version": 1
},
"project": {
"id": "31500"
},
"issuetype": {
"id": "3"
},
"summary": "My Engage Project"
},
"update": {}
}

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-post

 

2 answers

2 accepted

2 votes
Answer accepted
Rebekka Heilmann (viadee)
Community Champion
February 12, 2025

Hi @Prateek Vyas 

are you looking for the correct structure to achieve Headings, Bulletlists etc.?

Maybe the Document Builder is helpful for you: Document builder

You can write formatted text in the WYSIWYG-Editor and it gives you the ADF version ready to be pasted into your JSON.

1 vote
Answer accepted
Marc - Devoteam
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
February 13, 2025

Hi @Prateek Vyas 

You need to use the Atlassian Document Format 

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events