Sha256: 3b2f44a70eeb68f4e589c3a2b23309f84d73020034f2fb50c25ffe7f1c8611d5
Contents?: true
Size: 1.48 KB
Versions: 6
Compression:
Stored size: 1.48 KB
Contents
# SunshineConversationsClient::UserCreateBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**external_id** | **String** | A unique identifier for the user. The `externalId` can be used to link a user to the same conversation [across multiple devices](https://docs.smooch.io/guide/authenticating-users/). |
**signed_up_at** | **String** | The date at which the user signed up. Must be ISO 8601 time format `YYYY-MM-DDThh:mm:ss.sssZ`. | [optional]
**to_be_retained** | **Boolean** | Flag indicating whether a user should be retained after they have passed their inactive expiry. See [creating deletion schedules for bot-only conversations](https://support.zendesk.com/hc/en-us/articles/8499219792154) for more information. | [optional]
**profile** | [**Profile**](Profile.md) | | [optional]
**metadata** | [**Object**](.md) | 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
```ruby
require 'SunshineConversationsClient'
instance = SunshineConversationsClient::UserCreateBody.new(external_id: your-own-id,
signed_up_at: 2020-05-21T15:53:30.197Z,
to_be_retained: null,
profile: null,
metadata: {"lang":"en-ca"})
```
Version data entries
6 entries across 6 versions & 1 rubygems