POST /admin/legal-holds

Place hold

H5: freeze tenant or customer rows against purge.

Bearer API key or staff session application/json operation placeHold

Request

Content type: application/json · required

The contract does not publish field-level properties for this request; the example below sends an empty object. Replace it with the payload described by the endpoint.

curl -X POST "$MONICHEK_API/admin/legal-holds" \
  -H "Authorization: Bearer $MONICHEK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

const res = await fetch(`${MONICHEK_API}/admin/legal-holds`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${MONICHEK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

const data = await res.json();

import os
import requests

res = requests.post(
    f"{os.environ['MONICHEK_API']}/admin/legal-holds",
    headers={"Authorization": f"Bearer {os.environ['MONICHEK_API_KEY']}"},
    json={},
)
print(res.json())

$ch = curl_init(getenv('MONICHEK_API') . '/admin/legal-holds');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('MONICHEK_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

201 Created hold application/json

No response example is published for this status.