Skip to main content
PUT
Update a folder

Authorizations

x-api-key
string
header
required
Authorization
string
header
required

Path Parameters

matterId
string
required

Unique identifier of the matter.

folderId
string
required

Unique identifier of the folder.

Body

The full set of folder fields to apply.

name
string
required

Name of the folder. Required; must not be empty or whitespace. Maximum 256 characters.

Required string length: 1 - 256
Example:

"Property Documents"

parentFolderId
string | null

Unique identifier of the parent folder. Must be a valid GUID when supplied. Null or omitted means the matter root: on create the folder is created under the root, on PUT the folder is moved to the root. The parent folder is not validated for existence.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

userId
string | null

Unique identifier of the user modifying the folder. Must be a valid GUID when supplied. If null it will fallback to the authenticated user.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

Response

When request is accepted. Returns a hypermedia 'Link' object of the folder to be updated.

id
string | null
href
string | null
relation
string | null
method
string | null
default:GET