API reference OpenAPI 3.1
PATCH /obligations/{id}

Update an obligation

Bearer API key or staff session application/json operation updateObligation

Parameters

NameInTypeRequiredDescription
id path string Yes —

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 PATCH "$MONICHEK_API/obligations/{id}" \
  -H "Authorization: Bearer $MONICHEK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
const res = await fetch(`${MONICHEK_API}/obligations/{id}`, {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${MONICHEK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

const data = await res.json();
import os
import requests

res = requests.patch(
    f"{os.environ['MONICHEK_API']}/obligations/{id}",
    headers={"Authorization": f"Bearer {os.environ['MONICHEK_API_KEY']}"},
    json={},
)
print(res.json())
$ch = curl_init(getenv('MONICHEK_API') . '/obligations/{id}');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    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;

Replace {id} with the resource id.

Responses

200 OK updated obligation application/json

No response example is published for this status.

Error responses

StatusMeaningBody
403 Forbidden RFC 9457 problem
404 Not Found RFC 9457 problem
422 Unprocessable Entity RFC 9457 problem

Errors use the RFC 9457 problem format with a stable code.