Skip to main content
PATCH
/
v1
/
compliance
/
obligations
/
{obligationId}
curl -X PATCH https://api.vouchmark.com/v1/compliance/obligations/obl_aBcD... \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "VAT filing (FIRS)",
    "nextDueDate": "2026-08-21",
    "notifyLeadDays": [14, 3]
  }'
{
  "success": true,
  "data": {
    "id": "obl_aBcD...",
    "companyId": "cmp_aBcD...",
    "category": "vat",
    "title": "VAT filing (FIRS)",
    "description": "Monthly VAT return filed with FIRS by the 21st.",
    "frequency": "monthly",
    "nextDueDate": "2026-08-21",
    "lastCompletedAt": null,
    "isSeeded": true,
    "isActive": true,
    "notifyLeadDays": [14, 3],
    "daysUntilDue": 55,
    "createdAt": "2026-06-01T09:00:00Z",
    "updatedAt": "2026-06-27T12:00:00Z"
  }
}
Updates an existing compliance obligation. All fields are optional; only the fields you send are changed. Returns the updated obligation object.

Path parameters

obligationId
string
required
The obligation ID.

Body

title
string
Obligation name.
description
string
Detail text. Pass null to clear it.
frequency
string
One of monthly, annual, one_off, custom.
nextDueDate
string
Next due date as a YYYY-MM-DD date string.
notifyLeadDays
integer[]
Reminder lead times in days before the due date.
isActive
boolean
Whether the obligation is actively tracked.
curl -X PATCH https://api.vouchmark.com/v1/compliance/obligations/obl_aBcD... \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "VAT filing (FIRS)",
    "nextDueDate": "2026-08-21",
    "notifyLeadDays": [14, 3]
  }'
{
  "success": true,
  "data": {
    "id": "obl_aBcD...",
    "companyId": "cmp_aBcD...",
    "category": "vat",
    "title": "VAT filing (FIRS)",
    "description": "Monthly VAT return filed with FIRS by the 21st.",
    "frequency": "monthly",
    "nextDueDate": "2026-08-21",
    "lastCompletedAt": null,
    "isSeeded": true,
    "isActive": true,
    "notifyLeadDays": [14, 3],
    "daysUntilDue": 55,
    "createdAt": "2026-06-01T09:00:00Z",
    "updatedAt": "2026-06-27T12:00:00Z"
  }
}