Create related work

POST

/rest/api/3/version/{id}/relatedwork

Creates a related work for the given version. You can only create a generic link type of related works via this API. relatedWorkId will be auto-generated UUID, that does not need to be provided.

This operation can be accessed anonymously.

Permissions required: Resolve issues: and Edit issues Managing project permissions for the project that contains the version.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/rest/api/3/version//relatedwork' \
--header 'Content-Type: application/json' \
--data-raw '{
    "category": "Design",
    "title": "Design link",
    "url": "https://www.atlassian.com"
}'

Response Example

{"category":"Design","relatedWorkId":"fabcdef6-7878-1234-beaf-43211234abcd","title":"Design link","url":"https://www.atlassian.com"}

Request

Path Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Returned if the request is successful.

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-16 07:18:01

Get related work

Update related work