Create Client Enrollment Batch
agency_enrollment_createCreates an enrollment session for 1-50 existing or new clients against a published offer version and returns one owner approval link per new client. Requires an agency owner, admin or operator with access to each existing client, and an idempotency key; a replay returns the session without the links. It sends no email and installs nothing.
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": {
"partnerId": "<partnerId>",
"offerVersionId": "<offerVersionId>",
"entries": "<entries>"
},
"name": "agency_enrollment_create"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entries | Yes | One entry per client: either businessId (existing client) or newClient (name, externalRef, ownerEmail), plus expectedRevision and intake facts. | |
| partnerId | Yes | The agency (partner) workspace ID. | |
| ownerEmail | No | Optional default owner email. | |
| idempotencyKey | No | Stable key for this request; reuse it when retrying the same request. | |
| offerVersionId | Yes | The published offer version to enroll clients in. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present when success is false | |
| receipt | No | ||
| success | Yes | Whether the tool completed successfully |