PATCH

/api/v1/documents/{DocumentId}/versions/{VersionId}

http://workdocs.{region}.amazonaws.com/api/v1/documents/{DocumentId}/versions/{VersionId}

<p>Changes the status of the document version to ACTIVE. </p> <p>Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by <a>InitiateDocumentVersionUpload</a>. </p>

Access Token Required: API Key

Path Parameters

DocumentIdstringrequired

The ID of the document.

VersionIdstringrequired

The version ID of the document.

Body Params

VersionStatusstring

The status of the version.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://workdocs.{region}.amazonaws.com/api/v1/documents/{DocumentId}/versions/{VersionId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}