Revoke Enrollment Session
agency_enrollment_revokeRevoke an enrollment session and all owner links to prevent further approvals or enrollments, while leaving existing enrolled installations unchanged.
Instructions
Revokes an enrollment session and all of its owner links so nothing more can be approved or enrolled from it. Requires the session creator or an agency owner/admin. Installations that were already enrolled are not removed.
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>",
"sessionId": "<sessionId>"
},
"name": "agency_enrollment_revoke"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| partnerId | Yes | The agency (partner) workspace ID. | |
| sessionId | Yes | The enrollment session to revoke. | |
| idempotencyKey | No | Stable key for this request; reuse it when retrying the same request. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present when success is false | |
| receipt | No | ||
| success | Yes | Whether the tool completed successfully |