SunshineConversationsClient::PassControlBody
August 27, 2025 ยท View on GitHub
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| switchboard_integration | String | The id or the name of the switchboard integration that will become active. May also use the `next` keyword to transfer control to the next switchboard integration designated in the switchboard hierarchy configuration | |
| reason | String | Reason for the pass control action. | [optional] |
| metadata | Hash<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. The metadata object will be included in the `switchboard:passControl` webhook. | [optional] |
Example
require 'sunshine-conversations-client'
instance = SunshineConversationsClient::PassControlBody.new(
switchboard_integration: next,
reason: null,
metadata: {"lang":"en-ca"}
)