patch/api/v2/reports/schedules/{id}
Update a report schedule.
Updates one project-scoped local report schedule. Omitted fields keep their stored values and updates record a schedule-updated delivery event.
Requires bearer API keyParameters
| Name | In | Description |
|---|---|---|
| X-Project-Id | header | Required for organization-wide API keys on project-scoped endpoints. Project-scoped keys infer the project automatically.string |
| id | path / required | No description provided.string |
Request Body
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"cadence": {
"type": "string",
"enum": [
"weekly",
"monthly"
]
},
"recipients": {
"type": "array",
"items": {
"type": "string"
}
},
"kind": {
"type": "string",
"enum": [
"pdf",
"executive_summary",
"competitor_snapshot"
]
},
"dateRange": {
"type": "string",
"enum": [
"last_7_days",
"last_14_days",
"last_30_days",
"last_90_days"
]
},
"enabled": {
"type": "boolean"
}
}
}Responses
200
application/jsonUpdated report schedule.
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"cadence": {
"type": "string"
},
"recipients": {
"type": "array",
"items": {
"type": "string"
}
},
"reportConfig": {
"type": "object",
"additionalProperties": true
},
"enabled": {
"type": "boolean"
},
"createdById": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"nextRunAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastRunAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastRunStatus": {
"type": "string",
"nullable": true
}
}
}400
application/jsonInvalid report schedule request.
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
}
}404
application/jsonReport schedule not found.
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
}
}Try it
Send this request to the local WatchLLM REST handler. Use a key from /workspace/api; organization keys can include X-Project-Id only when the endpoint documents that header.