Skip to main content
POST
/
bankaccounts
/
{id}
/
protect-funds
Protect bank account funds
curl --request POST \
  --url https://api.smokeball.com/bankaccounts/{id}/protect-funds \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "matterId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
  "amount": 100.5,
  "contactId": "18c05819-c321-4907-800c-d5a608729c5a",
  "reason": "Court order requiring protection of funds",
  "effectiveDate": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

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

Path Parameters

​
id
string
required

Body

​
matterId
string
required

Unique identifier of the associated matter. Required.

Minimum string length: 1
Example:

"da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262"

​
amount
number<double>
required

The amount to protect in dollars. Limited to 2 decimal places (cents).

Required range: x >= 0.01
Example:

100.5

​
contactId
string | null

Unique identifier of the associated contact. Required in US only.

Example:

"18c05819-c321-4907-800c-d5a608729c5a"

​
reason
string | null

Reason for protecting the funds.

Example:

"Court order requiring protection of funds"

​
effectiveDate
string<date-time>

Date of protecting the funds.

Response

When request is accepted. Returns a hypermedia 'Link' object.

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