Reports (Pro)
Update a scheduled report
Changes a scheduled report email: its report, schedule, covered period, recipients or whether it is active.
Requires: desk.supervise scope, Supervisor licence, Pro plan.
Authorization
bearerAuth AuthorizationBearer <token>
A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.
In: header
Path Parameters
id*string
The subscription's id (a UUID).
Request Body
application/json
Response
OK
Example
{ "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "report": "service", "report_title": "Service level", "name": "Amina Wanjiru", "frequency": "weekly", "weekday": 1, "month_day": 1, "send_hour": 1, "send_minute": 1, "covers": "yesterday", "format": "example", "active": false, "next_run_at": "2026-10-14T08:30:00Z", "last_run_at": "2026-10-14T08:30:00Z", "last_status": "delivered", "last_error": "", "created_by": "2faf86ee-f691-403c-936d-bb2014aaf0d1", "mine": false, "recipients": [ { "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "user_id": "ba7d8e12-8a4f-478d-9d10-86689fa3b682", "email": "amina@example.com", "name": "Amina Wanjiru" } ]}FieldTypeDescription
idrequiredstring (uuid)reportrequiredstringThe report to send, for example service or calls.report_titlerequiredstringnamerequiredstringA name for it.frequencyrequiredstringHow often it is sent: daily, weekly or monthly.weekdayrequiredinteger | nullFor weekly reports, the day to send on, from 1 (Monday) to 7 (Sunday).month_dayrequiredinteger | nullFor monthly reports, the day of the month to send on, from 1 to 28, or -1 for the last day of each month.send_hourrequiredintegerThe hour of the day to send, from 0 to 23, in the workspace's time zone.send_minuterequiredintegerThe minute of the hour to send, from 0 to 59.coversrequiredstringWhich days each report covers: yesterday, last_7_days or last_30_days.formatrequiredstringThe file format of the emailed report, for example csv.activerequiredbooleanTrue to switch it on, false to switch it off.next_run_atrequiredstring (date-time)last_run_atrequiredstring (date-time) | nulllast_statusrequiredstringlast_errorrequiredstringcreated_byrequiredstring (uuid)minerequiredbooleanrecipientsrequiredobject[]Who receives the report, each by user id or email address.idrequiredstring (uuid)user_idstring (uuid) | nullThe id of the person.emailrequiredstringAn email address.namerequiredstringA name for it.curl -X PATCH "https://api.sautidesk.com/v1/desk/reports/subscriptions/string" \ -H "Content-Type: application/json" \ -d '{ "report": "service", "name": "Amina Wanjiru", "frequency": "weekly", "weekday": 1, "month_day": 1, "send_hour": 1, "send_minute": 1, "covers": "yesterday", "format": "example", "active": false, "recipients": [ { "user_id": "ba7d8e12-8a4f-478d-9d10-86689fa3b682", "email": "amina@example.com" } ] }'