SunshineConversationsClient::UserUpdateBody

August 27, 2025 ยท View on GitHub

Properties

NameTypeDescriptionNotes
signed_up_atStringThe date at which the user signed up. Must be ISO 8601 time format `YYYY-MM-DDThh:mm:ss.sssZ`.[optional]
to_be_retainedBooleanFlag indicating whether a user should be retained after they have passed their inactive expiry. See creating deletion schedules for bot-only conversations for more information.[optional]
profileProfile[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::UserUpdateBody.new(
  signed_up_at: 2020-05-21T15:53:30.197Z,
  to_be_retained: null,
  profile: null,
  metadata: {&quot;lang&quot;:&quot;en-ca&quot;}
)