Module - subscriptions_ng.subscriptions.config

SubscriptionRecord

Validates and documents the contents of a subscription record.
type	object
properties
id	Id
	Uniquely identifies the subscription record.
	type	string
	format	uuid
user_id	User Id
	User owning the subscription. The export will be performed impersonating this user.
	type	string
	format	uuid
email	Email
	Email address to which the subscription will be emailed.
	type	string
	format	email
schedule	Schedule
	How frequently to run the subscription.
	type	string
	examples	HOURLY
		DAILY
		WEEKLY
		MONTHLY
		YEARLY
day_of	Day Of
	Day of week on which to run subscription. If schedule is WEEKLY, value is the weekday on which to run, with 0 being Sunday. If schedule is MONTHLY, value is the date of the month on which to run, 1-31. If schedule is DAILY, the value is ignored.
	type	integer
	maximum	31
	minimum	0
	default	0
send_at	Send At
	The 24 hour time at which to run the subscription in the timezone specified by tz. Format: HH:MM:SS Precisely when a subscription is actually run depends upon the frequency with which the Subscriptions job runs. The accuracy of send_at is no greater than this frequency.
	type	string
	examples	01:23:45
		23:00:00
	format	time
tz	Tz
	The timezone associated with send_at. Must be a timezone from the [tz database]( https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
	type	string
	examples	America/Chicago
		US/Eastern
		UTC
source	Source
	Source of export. In the case of a Zuar Portal Export, this is the base URL of the Portal.
	type	string
	examples	https://portal-automation.zuarbase.net
		https://portal.zuar.com
json_data	Json Data
	Optional additional data. Used to construct view filters in Subscriptions V2. Used to provide user and other data in Subscriptions-ng.
	type	string
	default	{}
	format	json-string
updated_at	Updated At
	Date subscription was last updated.
	type	string
	format	date-time
created_at	Created At
	Date subscription originally created.
	type	string
	format	date-time
additionalProperties	False