Offboard Installation
agency_installation_offboardStarts offboarding: stops the package's jobs, revokes its future automation authority and turns off its scheduled reports. Requires the client owner, accepted set to true and the fingerprint from preview_offboard. The phone number, connections, billing plan and history are kept.
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>",
"installationId": "<installationId>",
"expectedRevision": "<expectedRevision>"
},
"name": "agency_installation_offboard"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| accepted | No | Must be true to confirm the owner accepts the previewed effects. | |
| partnerId | Yes | The agency (partner) workspace ID. | |
| fingerprint | No | The fingerprint returned by the matching preview action. | |
| installationId | Yes | The agency package installation to act on. | |
| expectedRevision | Yes | The installation revision you last read. The call is rejected if the installation has changed since. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present when success is false | |
| receipt | No | ||
| success | Yes | Whether the tool completed successfully |