Own AWS? Customize your docs with AI search, analytics, and more.

PATCH

/api/v1/documents/{DocumentId}

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

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

Access Token Required: API Key

Path Parameters

DocumentIdstringrequired

The ID of the document.

Body Params

Namestring

The name of the document.

ResourceStatestring

The resource state of the document. Only ACTIVE and RECYCLED are supported.

ParentFolderIdstring

The ID of the parent folder.

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}' \
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}

PATCH

/api/v1/documents/{DocumentId}

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

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

Access Token Required: API Key

Path Parameters

DocumentIdstringrequired

The ID of the document.

Body Params

Namestring

The name of the document.

ResourceStatestring

The resource state of the document. Only ACTIVE and RECYCLED are supported.

ParentFolderIdstring

The ID of the parent folder.

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}' \
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}

PATCH

/api/v1/documents/{DocumentId}

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

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

Access Token Required: API Key

Path Parameters

DocumentIdstringrequired

The ID of the document.

Body Params

Namestring

The name of the document.

ResourceStatestring

The resource state of the document. Only ACTIVE and RECYCLED are supported.

ParentFolderIdstring

The ID of the parent folder.

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}' \
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}

PATCH

/api/v1/documents/{DocumentId}

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

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

Access Token Required: API Key

Path Parameters

DocumentIdstringrequired

The ID of the document.

Body Params

Namestring

The name of the document.

ResourceStatestring

The resource state of the document. Only ACTIVE and RECYCLED are supported.

ParentFolderIdstring

The ID of the parent folder.

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}' \
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}