Update Request Stage

put

https://{hostname}/api/datasubject/v2/requestqueues/{requestQueueRefId}/movestages/{language}

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.

Path Params

requestQueueRefId

string

required

The 10-character unique identifier of the request.

language

string

required

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

Body Params

nextStage

string

required

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

resolutionTitle

string

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.

comments

string

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

isInternalComment

boolean

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

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200OK

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