SunshineConversationsClient::AndroidUpdate

August 27, 2025 ยท View on GitHub

Properties

NameTypeDescriptionNotes
display_nameStringA human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`.[optional]
default_responder_idStringThe default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href=&quot;https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\&quot;&gt;Switchboard guide</a>.[optional]
project_idStringYour project ID from your generated private key file.[optional]
client_emailStringYour client email from your generated private key file.[optional]
private_keyStringYour private key from your generated private key file.[optional]
server_keyStringYour server key from the fcm console.[optional]
sender_idStringYour sender id from the fcm console.[optional]
can_user_see_conversation_listBooleanAllows users to view their list of conversations. By default, the list of conversations will be visible. This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`.[optional]
can_user_create_more_conversationsBooleanAllows users to create more than one conversation on the android integration.[optional]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::AndroidUpdate.new(
  display_name: My awesome integration,
  default_responder_id: null,
  project_id: &lt;project-id&gt;,
  client_email: &lt;client-email&gt;,
  private_key: &lt;private-key&gt;,
  server_key: &lt;server-key&gt;,
  sender_id: &lt;sender-id&gt;,
  can_user_see_conversation_list: false,
  can_user_create_more_conversations: null
)