ScheduleDefinition

The ScheduleDefinition object is a run-time set of attributes used to schedule an email send or program.

Properties

NameData TypeDescription
ClientClientIDSpecifies the account ownership and context of an object.
CorrelationIDxsdIdentifies correlation of objects across several requests.
CreatedDatexsdRead-only date and time of the object's creation.
CustomerKeyxsdUser-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object in Marketing Cloud.
DescriptionxsdDescribes and provides information regarding the object.
EndDateTimexsdSpecifies end time of schedule definition
IDxsdRead-only identifier for an object. Some objects use the ObjectID property as the Marketing Cloud unique ID.
KeywordxsdReserved for future use.
ModifiedDateNullable`1Indicates the last time object information was modified.
NamexsdName of the object or property.
ObjectIDxsdSystem-controlled, read-only text string identifier for object.
ObjectStatexsdReserved for future use.
OccurrencesxsdSpecifies number of times to run a schedule definition.
OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account.
PartnerKeyxsdUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerPropertiesAPIProperty[]A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
RecurrenceRecurrenceInterval of recurrence type.
RecurrenceRangeTypeRecurrenceRangeTypeEnumDefines how a recurrence type ends.
RecurrenceTypeRecurrenceTypeEnumSpecifies type of recurrence, such as daily or hourly.
StartDateTimexsdSpecifies start time of schedule definition
TimeZoneTimeZoneContains time zone information for an Account. For Create and Update calls, this property defines the time zone for an Account object. On a Retrieve call, TimeZone indicates which time zone is in effect for the Account object in question. Without a specific time zone, the Account defaults to Central Standard Time.

Schedule a User-Initiated Email Message Send