enroll_clients_in_program
Start a program for some clients and/or groups, with Day 1 on startDate (yyyy-MM-dd). Confirm-gated: without confirm the server previews who would start and who would be skipped (and why), writing nothing. Show that list to the coach, then confirm: true. Each client gets their own copy, so one can be changed later. Undo with undo_program_assignment.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"programId": "<programId>",
"startDate": "<startDate>"
},
"name": "enroll_clients_in_program"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | Must be true to actually execute. If false/omitted, returns a preview only. | |
| groupIds | No | Group ids (from list_client_groups) | |
| timeZone | No | IANA zone; default is each client's own | |
| clientIds | No | Client User _ids (from list_clients) | |
| programId | Yes | ||
| startDate | Yes | Day 1 | |
| allowDuplicates | No | Also start a client who is already on this program | |
| excludeClientIds | No |