Bulk Actions

Bulk Actions

POST /siren/v1/collaborators/bulk

Performs an action on multiple collaborators at once.

Request Body:

Field	Type	Required	Description
action	string	Yes	One of: activate, deactivate, restore, delete, permanent_delete, addToProgram, removeFromProgram, sendSignupEmail
ids	integer[]	Yes	Array of collaborator IDs to act upon
programId	integer	Conditional	Required when action is addToProgram or removeFromProgram

Action Behaviors:

Action	Effect
activate	Sets status to active
deactivate	Sets status to inactive
restore	Sets status to inactive (restores from trash for review)
delete	Sets status to deleted (soft delete)
permanent_delete	Permanently removes records from the database
addToProgram	Enrolls collaborators in the specified program
removeFromProgram	Removes collaborators from the specified program
sendSignupEmail	Sends the signup/registration email to each collaborator (broadcasts CollaboratorAccountReady per record)

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

Example Request:

{
  "action": "addToProgram",
  "ids": [7, 12, 19],
  "programId": 3
}

Example Response:

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