SunshineConversationsClient::ConversationUpdateBody

August 27, 2025 ยท View on GitHub

Properties

NameTypeDescriptionNotes
display_nameStringA friendly name for the conversation, may be displayed to the business or the user.[optional]
descriptionStringA short text describing the conversation.[optional]
icon_urlStringA custom conversation icon url. The image must be in either JPG, PNG, or GIF format[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]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::ConversationUpdateBody.new(
  display_name: null,
  description: Conversation between Rogers and Carl.,
  icon_url: https://www.gravatar.com/image.jpg,
  metadata: {&quot;lang&quot;:&quot;en-ca&quot;}
)