Create a report schedule

Módulo Reports

POST/report-schedulesreportSchedules.create

A scheduled email delivery of a report to org members only. Creates a report schedule. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requiere la capacidad reports.schedule.write.
Alcances de OAuth: reports.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: ReportScheduleCreate

reportSchedules.create: ReportScheduleCreate
Campo	Tipo	Obligatorio	Descripción
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	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"	Sí	File format attached: CSV, XLSX or PDF.
paused_at	string (date-time) \| null	No	When the schedule was paused; null while it runs.

{
  "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",
  "paused_at": "2026-10-08T14:30:00Z"
}

Respuesta 201: ReportSchedule

reportSchedules.create: 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 POST "$XOS_BASE_URL/report-schedules" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"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","paused_at":"2026-10-08T14:30:00Z"}'

const { data } = await xos.reportSchedules.create({
    "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",
    "paused_at": "2026-10-08T14:30:00Z"
  });

response = xos.report_schedules.create({"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", "paused_at": "2026-10-08T14:30:00Z"})

xos report-schedules create --data '{"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","paused_at":"2026-10-08T14:30:00Z"}'