Skip to content
XOS Developers

Delete a report schedule recipient

Reports module

DELETE/report-schedule-recipients/{id}reportScheduleRecipients.delete

A member of the org a scheduled report is emailed to; each receives it run with their own access, so a report never leaves the org (Section 4.6.4). Soft-deletes the report schedule recipient: 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

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

Response 204: no body.

Code samples

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