SMsmokeball
Folders

Create a folder

Creates a new folder under the specified matter.

When parentFolderId is null or omitted the folder is created under the matter root.

post/matters/{matterId}/documents/folders

Request

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

Path parameters

matterIdstring required

Unique identifier of the matter.

Request body

namestring required

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

parentFolderIdstring nullable

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.

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.

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 created.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.