feed APIv1.3.1

CreateUserScheduleRequest

The type that defines the fields for the createSchedule method.

Types that use CreateUserScheduleRequest

Not used by any types

Call that uses CreateUserScheduleRequest

Fields

Field
Type
Description
feedType
The name of the feed type for the created schedule. Match the feed_type from the schedule template associated with this schedule.
preferredTriggerDayOfMonth
The preferred day of the month to trigger the schedule. This field can be used with preferredTriggerHour for monthly schedules. The last day of the month is used for numbers larger than the actual number of days in the month.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Minimum: 1

Maximum: 31
preferredTriggerDayOfWeek
The preferred day of the week to trigger the schedule. This field can be used with preferredTriggerHour for weekly schedules.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.
preferredTriggerHour
The preferred two-digit hour of the day to trigger the schedule.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Format: UTC hhZ

For example, the following represents 11:00 am UTC: 11Z
scheduleEndDate
The timestamp on which the report generation (subscription) ends. After this date, the schedule status becomes INACTIVE.

Use this field, if available, to end the schedule in the future. This value must be later than scheduleStartDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Format: UTC yyyy-MM-ddTHHZ

For example, the following represents UTC October 10, 2021 at 10:00 AM:
2021-10-10T10Z
scheduleName
The schedule name assigned by the user for the created schedule.
scheduleStartDate
The timestamp to start generating the report. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplateId becomes inactive.

Use this field, if available, to start the schedule in the future but before the scheduleEndDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.

Format: UTC yyyy-MM-ddTHHZ

For example, the following represents a schedule start date of UTC October 01, 2020 at 12:00 PM:
2020-01-01T12Z
scheduleTemplateId
The ID of the template associated with the schedule ID. You can get this ID from the documentation or by calling the getScheduleTemplates method. This method requires a schedule template ID that is ACTIVE.
schemaVersion
The schema version of the schedule feedType. This field is required if the feedType has a schema version.

This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.