Options
The Options object is the base object for all options on methods, such as Create. Specify ClientID on this option during a call to avoid having to specify ClientID on all objects within the call.
| Name | Data Type | Description |
|---|---|---|
CallsInConversation | Integer | The number of calls that must be received before the asynchronous API begins processing the conversation. |
Client | ClientID | Specifies the account ownership and context of an object. |
ConversationID | String | Unique ID of initial async API call. |
Priority | String | Deprecated. |
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 AsyncResponse objects | Defines how responses are returned and under what conditions. |
SequenceCode | Integer | Specifies the processing sequence of a multi-step conversation. |