Update an issue#

Description#

Apply a JSON Patch (RFC 6902) to a remediation issue. Only the replace operation is supported. Include one operation per field you want to change, at most 100 operations; fields without an operation are left unchanged.

Options#

A custom field is patched by its custom field id, not by replacing the /customFields array. The value is an object with exactly one of stringValue, dateValue, enumValue, or enumValues, matching the field’s type. A null value clears that field. Other custom fields on the issue are left unchanged.

Status transitions are not supported via PATCH; attempting to patch /status returns 400.

PATCH /issues/{id}

Required OAuth Scopes

grc:write

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	true	Version of the API (2026-09-01.grc.preview)
id	path	string	true	The unique system identifier of the resource.
body	body	JSONPatchDocument	true
Wk-Workspace	header	string	true	The id of the Workiva workspace to operate in. Authorization is enforced against the authenticated user’s access within this workspace.

Body parameter example#

[
  {
    "op": "replace",
    "path": "/name",
    "value": "Updated issue name"
  },
  {
    "op": "replace",
    "path": "/severity",
    "value": "high"
  },
  {
    "op": "replace",
    "path": "/rootCause",
    "value": null
  },
  {
    "op": "replace",
    "path": "/customFields/8f3c1a2b-4d5e-4f6a-8b7c-9d0e1f2a3b4c",
    "value": {
      "enumValue": "High"
    }
  }
]

Code Samples#

curl

curl -X PATCH 'https://api.app.wdesk.com/issues/{id}' \
    -H 'Content-Type: application/json-patch+json' \
    -H 'Accept: application/json' \
    -H 'Wk-Workspace: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2026-09-01.grc.preview' \
    --data-raw '[{"op":"replace","path":"/name","value":"Updated issue name"},{"op":"replace","path":"/severity","value":"high"},{"op":"replace","path":"/rootCause","value":null},{"op":"replace","path":"/customFields/8f3c1a2b-4d5e-4f6a-8b7c-9d0e1f2a3b4c","value":{"enumValue":"High"}}]'

httpie

echo '[{"op":"replace","path":"/name","value":"Updated issue name"},{"op":"replace","path":"/severity","value":"high"},{"op":"replace","path":"/rootCause","value":null},{"op":"replace","path":"/customFields/8f3c1a2b-4d5e-4f6a-8b7c-9d0e1f2a3b4c","value":{"enumValue":"High"}}]' | http PATCH https://api.app.wdesk.com/issues/{id} \
    X-Version:2026-09-01.grc.preview \
    Content-Type:application/json-patch+json \
    Accept:application/json \
    Wk-Workspace:1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d \
    Authorization:"Bearer {access-token}"

wget

wget --method=PATCH "https://api.app.wdesk.com/issues/{id}" \
    --output-document - \
    --header 'Content-Type: application/json-patch+json' \
    --header 'Accept: application/json' \
    --header 'Wk-Workspace: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d' \
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2026-09-01.grc.preview' \
    --body-data='[{"op":"replace","path":"/name","value":"Updated issue name"},{"op":"replace","path":"/severity","value":"high"},{"op":"replace","path":"/rootCause","value":null},{"op":"replace","path":"/customFields/8f3c1a2b-4d5e-4f6a-8b7c-9d0e1f2a3b4c","value":{"enumValue":"High"}}]'

python

import requests

headers = {
  'X-Version': '2026-09-01.grc.preview',
  'Content-Type': 'application/json-patch+json',
  'Accept': 'application/json',
  'Wk-Workspace': '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d',
  'Authorization': 'Bearer {access-token}'
}

body = [
  {
    "op": "replace",
    "path": "/name",
    "value": "Updated issue name"
  },
  {
    "op": "replace",
    "path": "/severity",
    "value": "high"
  },
  {
    "op": "replace",
    "path": "/rootCause",
    "value": None
  },
  {
    "op": "replace",
    "path": "/customFields/8f3c1a2b-4d5e-4f6a-8b7c-9d0e1f2a3b4c",
    "value": {
      "enumValue": "High"
    }
  }
]

r = requests.patch('https://api.app.wdesk.com/issues/{id}', headers = headers, json=body)

print(r.json())

Returns#

200 - The updated issue.#

A remediation issue — a finding, deficiency, or action item tracked through resolution. Issues link to controls, processes, and risks via point-in-time snapshots that record the state of those entities when the issue was created; the snapshot data is returned as lightweight digests using the live entity identifiers where available.