Update Issue

put

https://{hostname}/api/issue-management/v1/issues/{issueId}

Use this API to update all details for a specific issue.

🗒
Things to Know

The attributes parameter must be included in the request body but is not required to have values. If there are no attributes to send, pass an empty object {} in the following manner: "attributes": {}. However, if values exist for an attribute, you must include the values for each of those attribute to ensure the values are retained. Otherwise, they will be overwritten.

Path Params

issueId

uuid

required

The unique identifier of the issue. This value is obtained using the Get List of Issues API.

Body Params

name

string

required

length ≤ 300

The name that describes the issue.

orgGroupId

uuid

required

The unique identifier of the organization associated with the issue.

priority

string

enum

required

The priority level of the issue.

Allowed:

description

string

length ≤ 4000

The description of the issue.

deadline

date

The date by which the issue should be resolved.

ownerIds

array of uuids

The unique identifiers of the issue owners who will remediate the issue.

ownerIds

approverIds

array of uuids

The unique identifier(s) of the users assigned as approvers of the issue.

approverIds

reasonForClosure

string

The reason why the issue was closed.

202Accepted

400Missing required attributes

429Too Many Requests. For more information, see API Rate Limits.