ScheduleDefinition
The ScheduleDefinition object is a run-time set of attributes used to schedule an email send or program.
| Name | Data Type | Description |
|---|---|---|
Client | ClientID | Specifies the account ownership and context of an object. |
CorrelationID | String | Identifies correlation of objects across several requests. |
CreatedDate | DateTime | The date and time when the object was created. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
Description | String | Describes and provides information regarding the object. |
EndDateTime | DateTime | Specifies end time of schedule definition. |
ID | Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
Keyword | String | Not used. |
ModifiedDate | DateTime | The date and time when the object was last modified. |
Name | String | Name of the object or property. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
ObjectState | String | Not used. |
Occurrences | Int | Specifies number of times to run a schedule definition. |
Owner | Owner | Describes account ownership of subscriber in an on-your-behalf account. |
PartnerKey | String | Unique identifier provided by partner for an object. This property is accessible only via API. |
PartnerProperties | Array of APIProperty objects | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. |
Recurrence | Recurrence | Interval of recurrence type. |
RecurrenceRangeType | RecurrenceRangeTypeEnum | Defines how a recurrence type ends. |
RecurrenceType | RecurrenceTypeEnum | Specifies type of recurrence, such as daily or hourly. |
StartDateTime | DateTime | Specifies start time of schedule definition. |
TimeZone | TimeZone | Contains 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. |