--- updatedAt: 2026-05-27T12:51:18.000Z agentTools: projectIndex: https://developer.onetrust.com/onetrust/llms.txt --- # Update Subtask Status Use this API to update the status of an existing subtask. > 🗒 Things to Know > > - The following statuses can be passed as parameter values in the request: `IN_PROGRESS`, `FAILED`, `COMPLETED`, and `REJECTED`. > - The Resolution ID can only be passed if the subtask status is updated to `COMPLETED` or `REJECTED`. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Privacy Automation - Data Subject Request (DSR) Automation", "version": "1.0", "contact": { "name": "OneTrust Support", "url": "https://my.onetrust.com/s/contactsupport" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "description": "The Privacy Rights Automation are used to manage, process, and fulfill data subject access requests (DSARs), including request creation, subtask management, resolution codes, verification methods, and audit history." }, "servers": [ { "url": "https://{hostname}", "variables": { "hostname": { "default": "hostname", "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com." } } } ], "tags": [ { "name": "Subtasks", "description": "APIs used to create, update, complete, and reprocess subtasks associated with privacy requests.", "externalDocs": { "description": "OpenAPI 3.1.0 - Download Definition", "url": "https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json" }, "x-displayName": "Subtasks" } ], "paths": { "/api/datasubject/v2/subtasks/{subtaskId}/status": { "put": { "operationId": "updateSubtaskStatusUsingPUT", "summary": "Update Subtask Status", "description": "Use this API to update the status of an existing subtask.\n\n> 🗒 Things to Know\n>\n> - The following statuses can be passed as parameter values in the request: `IN_PROGRESS`, `FAILED`, `COMPLETED`, and `REJECTED`.\n> - The Resolution ID can only be passed if the subtask status is updated to `COMPLETED` or `REJECTED`.", "tags": [ "Subtasks" ], "x-onetrust": { "spec-label": "https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json" }, "parameters": [ { "name": "subtaskId", "in": "path", "required": true, "schema": { "description": "Subtask Id", "type": "string", "format": "uuid" }, "example": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_UpdateSubtaskStatusRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).", "headers": { "Retry-After": { "schema": { "description": "The number of seconds after which requests will be allowed again.", "format": "int32" } }, "ot-period": { "schema": { "description": "The unit of time for which the rate limit applies", "enum": [ "HOUR", "MINUTE" ] } }, "ot-ratelimit-event-id": { "schema": { "description": "The unique identifier for the rate-limiting event.", "format": "uuid" } }, "ot-request-made": { "schema": { "description": "The number of requests made within the specified period.", "format": "int32" } }, "ot-requests-allowed": { "schema": { "description": "The number of requests allowed within the specified period.", "format": "int32" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2": [ "DSAR", "DSAR_WRITE" ] } ] } } }, "components": { "schemas": { "PrivacyAutomation-DataSubjectRequestDSRAutomation_UpdateSubtaskStatusRequest": { "type": "object", "properties": { "comment": { "description": "Comments can be updated for system subtask status call - this can be used for reason for failure. Longer comments may impact system performance.", "type": "string", "example": "Updating the status for this reason", "maxLength": 1500000 }, "status": { "description": "Status to be updated to completed or failed", "type": "string", "example": "FAILED", "enum": [ "IN_PROGRESS", "FAILED", "COMPLETED", "REJECTED" ] }, "resolutionId": { "description": "Resolution ID (can only be passed if the subtask status is updated to COMPLETED or REJECTED)", "type": "string", "format": "uuid", "example": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad" } }, "required": [ "status" ] } }, "securitySchemes": { "PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://{hostname}/api/access/v1/oauth/token", "scopes": { "DSAR_READ": "Read-only access to DSAR objects scope for external systems", "DSAR_WRITE": "Access to DSAR objects scope for external systems", "DSAR": "Access to DSAR objects scope for external systems" } } } } } }, "x-readme": { "explorer-enabled": false, "proxy-enabled": false, "metrics-enabled": false }, "x-onetrust": { "spec-label": "OpenAPI 3.1.0" } } ``` # Sibling pages * [Get List of Subtasks by Request](https://developer.onetrust.com/onetrust/reference/getallsubtaskbyrefidusingget.md) * [Add Subtask to Request](https://developer.onetrust.com/onetrust/reference/createsubtaskusingpost.md) * [Get List of Subtasks](https://developer.onetrust.com/onetrust/reference/subtasksusingget.md) * [Get Subtask](https://developer.onetrust.com/onetrust/reference/getsubtaskbyidusingget.md) * [Add Targeted Data Discovery Details to Subtask](https://developer.onetrust.com/onetrust/reference/adddatadiscoveryusingput.md) * [Update Subtask](https://developer.onetrust.com/onetrust/reference/updatesubtaskusingput.md) * [Reprocess System Subtask](https://developer.onetrust.com/onetrust/reference/reprocesssubtaskusingput.md) * [Complete Subtask](https://developer.onetrust.com/onetrust/reference/completesubtaskusingput.md) * [Get List of Subtasks by Criteria](https://developer.onetrust.com/onetrust/reference/getallsubtasksv3usingpost.md) * [Add Subtask to Request using Subtask Template](https://developer.onetrust.com/onetrust/reference/createsubtaskfromtemplateusingpost.md)