Update subscription

Updates and returns a Subscription for a Report

patch/{account}/reports/{report}/subscriptions/{subscription}

Request

Path parameters

accountstring required

Account (Workspace or User) username

reportstring required

Report token

subscriptionstring required

ReportSubscription token

Request body

csv_attachmentsboolean

Whether or not to include Csv Attachments for subscribers to the scheduled run

pdf_attachmentsboolean

Whether or not to include Pdf Attachments for subscribers to the scheduled run

data_previewsboolean

Whether or not to include Data Previews for subscribers to the scheduled run

data_tablesboolean

Whether or not to include Data Tables for subscribers to the scheduled run

report_linksboolean

Whether or not to include Report Links for subscribers to the scheduled run

Example request

{
  "csv_attachments": true,
  "pdf_attachments": true,
  "data_previews": true,
  "data_tables": true,
  "report_links": true
}

Response

ReportSubscription response

data_previews_enabledboolean required
data_tables_enabledboolean required
csv_attachments_enabledboolean required
pdf_attachments_enabledboolean required
report_links_enabledboolean required
email_subscriber_countinteger required
_embeddedunknown

Changes

No recorded changes to this operation across all 28 revisions of this API.