Memos

Update a memo

Updates a specified memo.

put/matters/{matterId}/memos/{id}

Request

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

Path parameters

matterIdstring required
idstring required

Request body

titlestring required

The title of the memo.

textstring required

The text (content) of the memo.

Supports plain-text and RTF.

userIdstring nullable

Unique identifier of the user.

createdDateUtcstring date-time nullable

Date that the memo was created.

Will default to the current date and time, if not supplied.

Example request

{
  "title": "Update",
  "text": "There has been a recent update on this matter.",
  "userId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "createdDateUtc": "2022-07-01"
}

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

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