Contains options that are applied when you launch a campaign by using the Perform method.
note: This information applies to legacy campaigns. To manage modern journeys, automations, and triggered sends, use REST API. See Related Items.
Properties
| Name | Data Type | Description |
|---|---|---|
CallsInConversation |
Integer | Represents the number of calls that must be received before the conversation support in the asynchronous API begins processing. |
Client |
ClientID object | Specifies the account ownership and context of an object. |
ConversationID |
String | Unique ID of initial async API call. All requests that are processed as a single unit have the same ConversationID. |
Explanation |
String | Specifies a reason for pausing a running send. |
OccurrenceIDs |
Array of strings | Specifies the scheduled recurrences of a program. |
OccurrenceIDsIndex |
Integer | Specifies the index of the next occurrence. |
Priority |
String | Defines the priority for a triggered send. Valid values are Low, Medium, and High. |
QueuePriority |
Priority object | Defines the priority for asynchronous sends. Accepted values are High, Medium, and Low. The default value is Medium. |
RequestExpirationTime |
String | The date and time when the asynchronous API request expires. Specify the value in ISO 8601 format with UTC time or with a timezone offset. When you specify both RequestExpirationTime and ScheduledTime in a request, the RequestExpirationTime must occur after the ScheduledTime. |
RequestType |
RequestType | The type of request. Possible values are synchronous and asynchronous. |
SaveOptions |
Array of SaveOption objects | Specifies how information is overwritten. |
ScheduledTime |
String | The date and time at which the request must be processed. Specify the value in ISO 8601 format with UTC time or a timezone offset. The specified time can be up to 30 days in the future. |
SendResponseTo |
Array of AsyncResponse objects | Defines how responses are returned and under what conditions. |
SequenceCode |
Integer | Specifies the processing sequence of a multi-step conversation. If you specify this property, you must also specify ConversationID. |