Skip to main content
PATCH
/
matters
/
{matterId}
/
documents
/
folders
/
{folderId}
Patch a folder
curl --request PATCH \
  --url https://api.smokeball.com/matters/{matterId}/documents/folders/{folderId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Property Documents",
  "parentFolderId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "userId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"
}
'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

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

Path Parameters

​
matterId
string
required
​
folderId
string
required

Body

​
name
string
required

Name of the folder

Required string length: 1 - 256
Example:

"Property Documents"

​
parentFolderId
string | null

Unique identifier of the parent folder

Example:

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

​
userId
string | null

Unique identifier of the user modifying the folder. 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