SMsmokeball
Folders

Patch a folder

Changed on

Partially updates a folder belonging to the specified matter. Only the fields supplied in the request are applied.

A deleted folder can be restored by setting isDeleted to false. Only the folder itself is restored; subfolders and files that were deleted remain deleted. Other fields supplied in the same request are applied after the restore.

patch/matters/{matterId}/documents/folders/{folderId}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/matters/{matterId}/documents/folders/{folderId}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

matterIdstring required

Unique identifier of the matter.

folderIdstring required

Unique identifier of the folder.

Request body

namestring nullable

Name of the folder. If omitted the current name is kept. Must not be empty or whitespace when supplied.

parentFolderIdstring nullable

Unique identifier of the parent folder. Must be a valid GUID when supplied. If omitted the folder is not moved. Set to null to move the folder to the matter root. The destination must belong to the same matter; it is not validated for existence.

userIdstring nullable

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

isDeletedboolean nullable

A deleted folder can be restored by setting this to false. Only the folder itself is restored; previously deleted subfolders and files remain deleted. Setting this to true is not supported, use DELETE instead.

Example request

{
  "name": "Property Documents",
  "parentFolderId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "userId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"
}

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

  • db1b8a86b58eRevision changes
    • info

      added the new optional request property (media type: application/json-patch+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json-patch+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became optional (media type: application/json-patch+json)

    • info

      the request property became optional (media type: application/json)

    • info

      the request property became optional (media type: application/*+json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/json-patch+json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/*+json)