SunshineConversationsClient::SwitchboardPassControlAllOfPayload

August 27, 2025 ยท View on GitHub

Properties

NameTypeDescriptionNotes
conversationConversationTruncatedThe conversation from which the switchboard event was fired. On success, the payload will include an `activeSwitchboardIntegration`, representing the switchboard integration that is now in control of the conversation.[optional]
metadataHash<String, Object>Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.[optional]
reasonStringReason for the pass control action, if applicable.[optional]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::SwitchboardPassControlAllOfPayload.new(
  conversation: null,
  metadata: {&quot;lang&quot;:&quot;en-ca&quot;},
  reason: null
)