| 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. | |
| 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 for more information. | [optional] |
| profile | Profile | [optional] | |
| metadata | Hash<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] |
require 'sunshine-conversations-client'
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"}
)