SunshineConversationsClient::WhatsAppUpdate

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]
hsm_fallback_languageStringSpecify a fallback language to use when sending WhatsApp message template using the short hand syntax. Defaults to en_US. See WhatsApp documentation for more info.[optional][default to 'en_US']
account_idStringThe business ID associated with the WhatsApp account. In combination with accountManagementAccessToken, it’s used for Message Template Reconstruction.[optional]
account_management_access_tokenStringAn access token associated with the accountId used to query the WhatsApp Account Management API. In combination with accountId, it’s used for Message Template Reconstruction.[optional]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::WhatsAppUpdate.new(
  display_name: My awesome integration,
  default_responder_id: null,
  hsm_fallback_language: null,
  account_id: your_whatsApp_account_id,
  account_management_access_token: your_access_token
)