Update Obligation
Updates an existing obligation record. Only provided fields are changed.
Last updated: April 9, 2026
Update Obligation
PUT /siren/v1/obligations/{id}
Updates an existing obligation. Only provided fields are changed. The record must exist (enforced by RecordExistsMiddleware).
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
collaboratorId | integer | No | Updated collaborator ID (must exist) |
status | string | No | Updated status: pending, fulfilled, or cancelled |
awardType | string | No | Updated award type |
value | integer | No | Updated value |
payoutId | integer | No | Updated payout ID |
Middleware
RecordExistsMiddleware verifies the obligation exists before the update proceeds. CollaboratorAliasResolverMiddleware resolves collaborator aliases.
Example Request
{
"status": "fulfilled",
"payoutId": 7
}Events
Broadcasts ObligationActionEvent (action: Update) after success.