PATCH

/api/v1/folders/{FolderId}

http://workdocs.{region}.amazonaws.com/api/v1/folders/{FolderId}

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

Access Token Required: API Key

Path Parameters

FolderIdstringrequired

The ID of the folder.

Body Params

Namestring

The name of the folder.

ResourceStatestring

The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.

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/folders/{FolderId}' \
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}