Rest API to create release notes in JIRA

Jira Development Jira Cloud
1

Hi There,

I see that we can create release notes for each version in JIRA manually. Is there a Rest API that can help achieve the same?

3

Hello @RubabNaziri

Version Release Notes are considered to be Communications as part of Related Work, so in theory you should be able to manage them via the Project Version - Related Work endpoints, but there’s no information in the documentation about how to do it.

If you GET a Release Note from the Related Work of a Version, all the response provides is something vague like:

{
    "title": "Release Notes - Business Process Testing - Test version #1",
    "category": "Communication"
}

So there’s no information provided on how to structure a corresponding PUT / POST request to create a Release Note type of Communication. The documentation provides no other clues.

At the moment, the only type of Related Work Communication you can create via the REST API is a Link type:

{
    "relatedWorkId": "e0c08237-1d5e-416a-ad3e-aa85fd50fc0a",
    "title": "Atlassian home page",
    "category": "Communication",
    "url": "https://www.atlassian.com"
}