ConversationCreateBody.md

SunshineConversationsClient::ConversationCreateBody

Properties

Name	Type	Description	Notes
type	ConversationType
participants	Array<ParticipantSubSchema>	The users participating in the conversation. For `personal` conversations, this field is required with a length of exactly 1. For `sdkGroup` conversations, must have a length less than or equal to 10. Can be omitted to have a conversation with no participants if the type is `sdkGroup`.	[optional]
display_name	String	A friendly name for the conversation, may be displayed to the business or the user.	[optional]
description	String	A short text describing the conversation.	[optional]
icon_url	String	A custom conversation icon url. The image must be in either JPG, PNG, or GIF format	[optional]
metadata	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]

Code Sample

require 'SunshineConversationsClient'

instance = SunshineConversationsClient::ConversationCreateBody.new(type: null,
                                 participants: null,
                                 display_name: My conversation,
                                 description: Conversation between Rogers and Carl.,
                                 icon_url: https://www.gravatar.com/image.jpg,
                                 metadata: {"lang":"en-ca"})