Resolutions

Update Resolution

Use this API to update an existing resolution.

put/api/datasubject/v2/resolutions/{resolutionId}

Request

Base URL
https://hostname
URL
https://hostname/api/datasubject/v2/resolutions/{resolutionId}
Auth
OAuth 2
Client credentials
Token URL: https://{hostname}/api/access/v1/oauth/token scopes: DSAR, DSAR_WRITE

Path parameters

resolutionIdstring uuid required

resolutionId

Request body

idstring uuid

The unique identifier for the resolution code. This is automatically generated when a new resolution code is created, not required in resolution creation payload.

closeboolean required

Indicates whether this resolution code should be available as an option when closing a request. Set to true to make it available for closing requests.

rejectboolean required

Indicates whether this resolution code should be available as an option when rejecting a request. Set to true to make it available for rejecting requests.

completeboolean required

Indicates whether this resolution code should be available as an option when completing a request. Set to true to make it available for completing requests.

typeinteger

Specifies the type of resolution code, which determines where it appears in the UI. By default, this is set to 10 for request-level resolutions. Use 20 for subtask resolutions.

titleTranslationsobject

A map of language codes to translated titles for this resolution code. English (en-us) translation is required. Each translation must be unique per language and type across all resolution codes.

descriptionTranslationsobject

A map of language codes to translated descriptions for this resolution code. The default English (en-us) translation must be present.

Example request

{
  "id": "682488af-c26f-463e-9941-2f1582c6d4da",
  "close": true,
  "reject": true,
  "titleTranslations": {
    "en-us": "Opt Out",
    "fr": "Se désinscrire",
    "de": "Abmelden"
  },
  "descriptionTranslations": {
    "en-us": "Opt Out the Request",
    "fr": "Se désinscrire de la demande",
    "de": "Anfrage abmelden"
  }
}

Response