Siren

Bulk Actions

Perform an action on multiple obligations at once, including approve, reject, and delete.

Last updated: April 9, 2026

Bulk Actions

POST /siren/v1/obligations/bulk

Performs an action on multiple obligations at once.

Request Body

FieldTypeRequiredDescription
actionstringYesOne of: approve, reject, markPending, markComplete, delete, permanent_delete
idsinteger[]YesArray of obligation IDs to act upon

Action Behaviors

ActionStatus SetAuth Required
approveapprovedUpdate
rejectrejectedUpdate
markPendingpendingUpdate
markCompletecompleteUpdate
deletedeleted (soft delete)Delete
permanent_delete(record removed)Delete

Non-existent IDs are silently skipped. Datastore errors on individual records are logged but do not halt processing.

Example Request

{
  "action": "markComplete",
  "ids": [10, 11, 12]
}

Example Response

{
  "success": true,
  "affected": 3
}

Bulk Action Statuses

The bulk action endpoint supports additional status values (approved, complete, deleted) that map to the broader set of internal states used by the system for workflow management.