Siren

Create Collaborator

Create a new collaborator record with program enrollment.

Last updated: April 9, 2026

Create Collaborator

POST /siren/v1/collaborators

Creates a new collaborator record.

Request Body:

FieldTypeRequiredDescription
fullNamestringYesThe collaborator’s full name
nicknamestringYesDisplay name
emailstringYesEmail address (must be unique within the organization)
statusstringYesInitial status: active, inactive, or pending
programsinteger[]NoArray of program IDs to enroll the collaborator in (all must exist)

Example Request:

{
  "fullName": "Jane Smith",
  "nickname": "Jane",
  "email": "jane@example.com",
  "status": "active",
  "programs": [1, 3]
}

Example Response:

{
  "id": 7,
  "fullName": "Jane Smith",
  "nickname": "Jane",
  "email": "jane@example.com",
  "status": "active",
  "createdDate": "2026-04-08T12:00:00Z",
  "modifiedDate": "2026-04-08T12:00:00Z"
}

Events: Broadcasts CollaboratorActionEvent (action: Create) after success.