Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 2.54 KB

File metadata and controls

42 lines (30 loc) · 2.54 KB

ConversationVirtualAgentCapabilities

Properties

Name Type Description Notes
accessCustomCollections Boolean Permission flag to allow this Agent to search the merchant's custom Typesense collections. [optional]
accessStorefrontAndItem Boolean Permission flag to allow this Agent access to the storefront and item information. [optional]
cancelSubscription Boolean [optional]
customCollectionOids List<Integer> The custom collections this Agent is allowed to search. Empty means none, even when access_custom_collections is true. [optional]
customCollections List<ConversationVirtualAgentCapabilityCustomCollection> Read only. All of the merchant's custom collections, to populate the selection list for custom_collection_oids. Changes here are ignored. [optional]
delaySubscription Boolean [optional]
generateCoupon Boolean Permission flag to allow this Agent to generate coupons based upon the agent prompt instructions [optional]
lookupOrderInformation Boolean [optional]
lookupSubscriptionInformation Boolean [optional]
openSupportTicket Boolean [optional]
openSupportTicketChannel OpenSupportTicketChannelEnum Channel to use to open the support ticket [optional]
openSupportTicketChannelEmail String Email to send support ticket to [optional]
openSupportTicketZohoDeskDepartmentId String Department ID to open a Zoho Desk ticket for [optional]
pauseSubscription Boolean [optional]
resumeSubscription Boolean [optional]
transferChatToLiveAgent Boolean [optional]
updateSubscriptionCreditCard Boolean [optional]
zohoDeskAvailable Boolean True if Zoho Desk is connected to UltraCart [optional]
zohoDeskDepartments List<ConversationVirtualAgentCapabilityZohoDeskDepartment> Array of Zoho Desk Department if zoho desk is connected to UltraCart [optional]

Enum: OpenSupportTicketChannelEnum

Name Value
NONE "none"
EMAIL "email"
ULTRACART_TASK "ultracart_task"
ZOHO_DESK_TICKET "zoho_desk_ticket"