SunshineConversationsClient::IosUpdate

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]
certificateStringThe binary of your APN certificate base64 encoded.[optional]
passwordStringThe password for your APN certificate.[optional]
productionBooleanThe APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified.[optional]
auto_update_badgeBooleanUse the unread count of the conversation as the application badge.[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 iOS integration.[optional]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::IosUpdate.new(
  display_name: My awesome integration,
  default_responder_id: null,
  certificate: your_APN_certificate,
  password: your_APN_password,
  production: null,
  auto_update_badge: null,
  can_user_see_conversation_list: false,
  can_user_create_more_conversations: null
)