Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Request Queues

Update Request Stage

Use this API to update the workflow stage for a specific request.

🗒 Things to Know

  • The following system default statuses can be passed as parameter values in the request when moving to a different stage: NEW, VERIFYING_IDENTITY, IN_PROGRESS, REJECTED, and COMPLETE.
  • The resolutionTitle, comments, and isInternalComment parameters are only used when the nextStage parameter is set to REJECTED.
  • You will not be able to advance the request to the next stage if the current stage has required subtasks that have not been completed.

👍

For more information, see Processing a Request, Closing a Request, and Rejecting a Request.

put/api/datasubject/v2/requestqueues/{requestQueueRefId}/movestages/{language}

Path parameters

requestQueueRefIdstring required

Reference ID of the request

The 10-character unique identifier of the request.

languagestring required

The ISO language code for OneTrust supported languages.Examples: en-us for English, de for German, fr for French, etc.

The language code of the request data, such as en-us for English, de for German, fr for French, etc.

Request body

nextStagestring required

The name of the workflow stage to which the request will be moved.

resolutionTitlestring

The titleTranslation parameter value of the resolution. This value should be the translation that corresponds to the language code defined in the language parameter of this payload, if available. This value is obtained using the Get List of Resolutions API. This parameter is only used when the nextStage parameter is set to REJECTED.

commentsstring

The comments to add when rejecting the request. This parameter is only used when the nextStage parameter is set to REJECTED.

isInternalCommentboolean

This flag indicates whether the comment added when rejecting a request is for internal use only and will not appear in the Privacy Portal.

Example request

{
  "nextStage": "Rejected",
  "resolutionTitle": "Not a privacy-related request",
  "comments": "Any comment",
  "isInternalComment": true
}

Response

OK

requestQueueIdstring

The 10-character unique identifier of the request.

currentStagestring

The name of the current workflow stage.

statusCodeinteger

The numeric identifier for the resolution code.