Create Obligation

Create Obligation

POST /siren/v1/obligations

Creates a new obligation record.

Request Body

Field	Type	Required	Description
collaboratorId	integer	Yes	ID of the collaborator (must exist)
status	string	Yes	Initial status: pending, fulfilled, or cancelled
awardType	string	Yes	Type of award (e.g., commission)
value	integer	Yes	Value in smallest currency unit
payoutId	integer	No	ID of associated payout

Middleware

CollaboratorAliasResolverMiddleware resolves collaborator aliases before the request is processed.

Example Request

{
  "collaboratorId": 5,
  "status": "pending",
  "awardType": "commission",
  "value": 2500
}

Example Response

{
  "id": 11,
  "collaboratorId": 5,
  "status": "pending",
  "awardType": "commission",
  "value": 2500,
  "payoutId": null,
  "dateCreated": "2026-04-06T12:00:00Z",
  "dateModified": "2026-04-06T12:00:00Z"
}

Events

Broadcasts ObligationActionEvent (action: Create) after success.