Update a report schedule
Módulo Reports
PATCH/report-schedules/{id}reportSchedules.update
A scheduled email delivery of a report to org members only. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requiere la capacidad reports.schedule.write.
- Alcances de OAuth: reports.
- Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
- Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the report schedule. |
Cuerpo de la solicitud: ReportScheduleUpdate
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| time_zone | string | No | IANA time zone the local time was entered in.Restricciones: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$ |
| cadence | "Daily" | "Weekly" | "Monthly" | No | How often the report is sent. |
| local_hour | integer | No | Local hour of delivery, 0 to 23.Restricciones: range 0 to any |
| weekday | integer | null | No | ISO weekday (1 Monday) of a weekly delivery.Restricciones: range 1 to any |
| month_day | integer | null | No | Day of the month (1 to 28) of a monthly delivery.Restricciones: range 1 to any |
| export_format | "CSV" | "XLSX" | "PDF" | No | File format attached: CSV, XLSX or PDF. |
| paused_at | string (date-time) | null | No | When the schedule was paused; null while it runs. |
{
"time_zone": "America/New_York",
"cadence": "Daily",
"local_hour": 8,
"weekday": 1,
"month_day": 1,
"export_format": "CSV",
"paused_at": "2026-10-08T14:30:00Z"
}Respuesta 200: ReportSchedule
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the report schedule. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| report_definition_id | string (uuid) | Sí | Identifier of the report definition. |
| time_zone | string | Sí | IANA time zone the local time was entered in.Restricciones: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$ |
| cadence | "Daily" | "Weekly" | "Monthly" | Sí | How often the report is sent. |
| local_hour | integer | Sí | Local hour of delivery, 0 to 23.Restricciones: range 0 to any |
| weekday | integer | null | Sí | ISO weekday (1 Monday) of a weekly delivery.Restricciones: range 1 to any |
| month_day | integer | null | Sí | Day of the month (1 to 28) of a monthly delivery.Restricciones: range 1 to any |
| export_format | "CSV" | "XLSX" | "PDF" | Sí | File format attached: CSV, XLSX or PDF. |
| next_run_at | string (date-time) | Sí | Next delivery time, kept by the database. |
| paused_at | string (date-time) | null | Sí | When the schedule was paused; null while it runs. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"report_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"time_zone": "America/New_York",
"cadence": "Daily",
"local_hour": 8,
"weekday": 1,
"month_day": 1,
"export_format": "CSV",
"next_run_at": "2026-10-08T14:30:00Z",
"paused_at": "2026-10-08T14:30:00Z"
}Ejemplos de código
curl -X PATCH "$XOS_BASE_URL/report-schedules/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"time_zone":"America/New_York","cadence":"Daily","local_hour":8,"weekday":1,"month_day":1,"export_format":"CSV","paused_at":"2026-10-08T14:30:00Z"}'const { data, etag } = await xos.reportSchedules.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"time_zone": "America/New_York",
"cadence": "Daily",
"local_hour": 8,
"weekday": 1,
"month_day": 1,
"export_format": "CSV",
"paused_at": "2026-10-08T14:30:00Z"
}, { ifMatch: etag });response = xos.report_schedules.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"time_zone": "America/New_York", "cadence": "Daily", "local_hour": 8, "weekday": 1, "month_day": 1, "export_format": "CSV", "paused_at": "2026-10-08T14:30:00Z"}, if_match=etag)xos report-schedules update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"time_zone":"America/New_York","cadence":"Daily","local_hour":8,"weekday":1,"month_day":1,"export_format":"CSV","paused_at":"2026-10-08T14:30:00Z"}' --if-match auto