Update Collaborator
Update an existing collaborator's fields and program enrollments.
Last updated: April 9, 2026
Update Collaborator
PUT /siren/v1/collaborators/{id}
Updates an existing collaborator. Only provided fields are changed. The record must exist (enforced by RecordExistsMiddleware). Access is granted to administrators and to the collaborator themselves (owner-bound access).
Request Body:
| Field | Type | Required | Description |
|---|---|---|---|
fullName | string | No | Updated full name |
nickname | string | No | Updated display name |
email | string | No | Updated email address (must be unique within the organization) |
status | string | No | Updated status: active, inactive, pending, or rejected |
programs | integer[] | No | Complete set of program IDs. Replaces all current enrollments. |
When programs is provided, the collaborator’s current program enrollments are fully replaced. The response includes the updated programs list so the caller does not need a follow-up fetch.
Example Request:
{
"status": "inactive",
"programs": [1]
}
Example Response:
{
"id": 7,
"fullName": "Jane Smith",
"nickname": "Jane",
"email": "jane@example.com",
"status": "inactive",
"createdDate": "2026-04-08T12:00:00Z",
"modifiedDate": "2026-04-08T14:30:00Z",
"programs": [
{ "id": 1, "name": "Standard Affiliate" }
]
}
Events: Broadcasts CollaboratorActionEvent (action: Update) after success.