Skip to main content

Create Report Schedule

POST 
/v1/reports/:id/schedule

Schedule a deal report to be emailed on a recurring basis. Recipients must be active users of the caller's organization — outside emails are rejected. Each user has their own schedule per report: a second call by the same caller is rejected (use the update endpoint), but other users can still create their own schedule on the same shared report. Only deal reports support scheduling.

RRULE shape: the in-app schedule editor only renders rules of the form FREQ=WEEKLY;BYDAY=<days>;BYHOUR=<H>;BYMINUTE=<M>;BYSECOND=0. Schedules created via this endpoint with other shapes (e.g. FREQ=DAILY or FREQ=MONTHLY) save successfully and fire correctly, but break the editor on next open. Use FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;... to express a daily cadence.

Request​

Responses​

Schedule created