Skip to main content

Update Subscription Schedule​

Select

SaaS
Customer Managed

Modify the subscription properties like recipients, frequency, output type, etc.

Request Body
  • companyId integer
  • report object
  • reportId integer
  • reportName string
  • description string
  • subTaskId integer
  • taskId integer
  • scheduleName string
  • selfSubscription integer

    -1 if not subscribed, 1 if subscribed

  • companySubscription integer

    0,1,2,3,4,5 for none subscribed, tenant admins subscribed, tenant admins unsubscribed, tenant operators subscribed, tenant operators unsubscribed, both subscribed respectively

  • subscriptionToEmail integer

    -1 if user is unsubscribed from email, 0 otherwise

  • outputType integer

    0,1,2,3,4 for PDF,CSV,MHTML,PRINT,HTML respectively

  • scheduleUrl string
  • enabled integer
  • frequencyDetails object
  • freq_type integer
  • freq_interval integer
  • freq_relative_interval integer
  • freq_recurrence_factor integer
  • freq_subday_interval integer
  • skipOccurence integer
  • skipDayNumber integer
  • active_start_date integer
  • active_start_time integer
  • active_end_date integer
  • active_end_time integer
  • active_end_occurence integer
  • freq_restart_interval integer
  • next_schedule_time integer
  • timezone_type integer
  • timezoneDisplayName string
Responses

OK

Schema
  • error object
  • errorCode integer
  • errorMessage string
Loading...