The Options object is the base object for all options on methods, such as Create. To avoid specifying a ClientID for all objects in the call, specify ClientID on this object.
Properties
| Name | Data Type | Description |
|---|---|---|
CallsInConversation |
Integer | The number of calls that must be received before the asynchronous API begins processing the conversation. If you specify this property, you must also specify the ConversationID property. |
Client |
ClientID object | Specifies the account ownership and context of an object. |
ConversationID |
String | A unique ID for grouping multiple calls into a single conversation. All calls with the same ConversationID are processed as a single unit. |
Priority |
String | This property is deprecated. This property is allowed in API calls, but we recommend that you use the QueuePriority property in new API calls. |
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 object | 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 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 the ConversationID property. |