Schedule Activity Report Emails
agency_report_configureSet an installation's weekly or monthly activity report email schedule and replace its recipient list with verified business members. The scheduled job sends the first report after configuration.
Instructions
Sets the weekly or monthly activity report email schedule for an installation and replaces the previous recipient list. Requires the client owner; recipients must be verified members of the client's business. The first report is sent by the scheduled job, not by this call.
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>",
"recipients": "<recipients>",
"cadence": "<cadence>"
},
"name": "agency_report_configure"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cadence | Yes | weekly or monthly. | |
| partnerId | Yes | The agency (partner) workspace ID. | |
| recipients | Yes | User IDs (1-20) of verified business members who should receive the report. | |
| 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 |