POST
/v1/obligations/{id}/completeComplete an obligation
Marks what was owed as done, stamping who closed it and when. Body: optional notes and a documentId for the file that satisfies it. Legal from anything not already finished. Reach for post_obligations_id_waive when the obligation is being dropped rather than met.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
idpath · stringrequired
Request body
application/jsonrequiredbodyoptional
paramsoptional
queryobjectoptional
Responses
201application/json
the action's answer
{
"data": {
"amountMinor": 1,
"assignedToUserId": 1,
"breachSeverity": "string",
"completedAt": "string",
"completedByUserId": 1,
"counterpartyId": 1,
"createdAt": "string",
"currency": "string",
"dealRowId": "",
"decisionId": 1,
"description": "string",
"detail": {},
"documentId": 1,
"dueAt": "string",
"escalatedAt": "string",
"escalatedToUserId": 1,
"facilityId": 1,
"id": 1,
"isRecurring": true,
"notes": "string",
"obligationType": "string",
"parentObligationId": 1,
"priority": "string",
"recurrenceRule": "string",
"requiredDocumentType": "string",
"responsibleParty": "string",
"slaBreachAt": "string",
"slaHours": 1,
"status": "string",
"submissionId": 1,
"title": "string",
"updatedAt": "string",
"waivedAt": "string",
"waivedByUserId": 1,
"waivedReason": "string"
}
}dataoptional
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired