PUT
/
matters
/
{matterId}
/
archive
Update an archive for a matter.
curl --request PUT \
  --url https://api.smokeball.com/matters/{matterId}/archive \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "archivedDate": "2022-04-23T14:00:00Z",
  "archiveBoxNumber": "24",
  "archiveComments": "Lot 1",
  "archivedLocation": "Box",
  "destroyDate": "2022-04-29T14:00:00Z",
  "isArchived": true
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

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

Path Parameters

​
matterId
string
required

Body

​
isArchived
boolean
required

Flag indicating if the matter is archived.

Example:

true

​
archivedDate
string<date-time>

Date the matter was archived.

Example:

"2022-04-23T14:00:00Z"

​
archiveBoxNumber
string | null

Archive box number.

Example:

"24"

​
archiveComments
string | null

Archive comments.

Example:

"Lot 1"

​
archivedLocation
string | null

Archived location.

Example:

"Box"

​
destroyDate
string<date-time>

Date the files of the matter were destroyed.

Example:

"2022-04-29T14:00:00Z"

Response

When request is successful. The archive update has been accepted and will be updated shortly.

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