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:
| Field | Type | Required | Description |
|---|---|---|---|
fullName | string | Yes | The collaborator’s full name |
nickname | string | Yes | Display name |
email | string | Yes | Email address (must be unique within the organization) |
status | string | Yes | Initial status: active, inactive, or pending |
programs | integer[] | No | Array 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.