Skip to content
XOS Developers

Delete a report schedule

Reports module

DELETE/report-schedules/{id}reportSchedules.delete

A scheduled email delivery of a report to org members only. Soft-deletes the report schedule: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability reports.schedule.write.
  • OAuth scopes: reports.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

reportSchedules.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the report schedule.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/report-schedules/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.reportSchedules.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.report_schedules.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos report-schedules delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f