---
title: "PUT /user/preferences"
method: PUT
path: "/user/preferences"
tags: ["User"]
---

# PUT /user/preferences

`PUT /user/preferences`

## Request

- Base URL: `https://api.carbonvoice.app`
- URL: `https://api.carbonvoice.app/user/preferences`
- Auth: one of:
  - API key in header `pxtoken`
  - OAuth 2 (implicit, authorization URL `https://api.carbonvoice.app/oauth/authorize`)

## Request body

- UserPreferenceServiceModel
  - `boolean_preferences` BooleanUserPreferenceModel[], required
    - `category` 'message_card' | 'onboarding' | 'playback' | 'recording' | 'label' | 'conversation_feed' | 'tooltips' | 'home', required
    - `name` 'speed' | 'auto_clear_notification' | 'auto_clear_compressed_audio_messages' | 'compress_text_messages' | 'compress_to_ai_summary' | 'show_ai_summary' | 'ai_summary_display_mode' | 'show_transcript' | 'identity_complete' | 'languages_complete' | 'suggested_conversations_complete' | 'streaming' | 'waiting_room' | 'default_id' | 'message_compression_character_limit' | 'message_compression_line_limit' | 'education_page_complete' | 'single_tap_to_record' | 'show_mic_tooltip' | 'show_create_conversation_tooltip' | 'show_create_a_folder_tooltip' | 'show_message_info_translate_button_tooltip' | 'show_chats_tab_tooltip' | 'tap_on_message_card_mode' | 'show_educational_message_card_right_swipe' | 'user_goal_complete' | 'hide_checklist' | 'show_message_card_swipe' | 'show_bulleted_summary_tooltip' | 'user_role_complete' | 'attribution_complete' | 'work_environment_complete' | 'conversations_workspace_complete' | 'team_workspace_complete' | 'send_first_message_complete' | 'pinned_cards' | 'hidden_playlists' | 'speed_dial_complete' | 'agent_setup_complete' | 'voice_memo_auto_copy' | 'voice_memo_link_prefix', required
    - `value` boolean, required
  - `number_preferences` NumberUserPreferenceModel[], required
    - `category` 'message_card' | 'onboarding' | 'playback' | 'recording' | 'label' | 'conversation_feed' | 'tooltips' | 'home', required
    - `name` 'speed' | 'auto_clear_notification' | 'auto_clear_compressed_audio_messages' | 'compress_text_messages' | 'compress_to_ai_summary' | 'show_ai_summary' | 'ai_summary_display_mode' | 'show_transcript' | 'identity_complete' | 'languages_complete' | 'suggested_conversations_complete' | 'streaming' | 'waiting_room' | 'default_id' | 'message_compression_character_limit' | 'message_compression_line_limit' | 'education_page_complete' | 'single_tap_to_record' | 'show_mic_tooltip' | 'show_create_conversation_tooltip' | 'show_create_a_folder_tooltip' | 'show_message_info_translate_button_tooltip' | 'show_chats_tab_tooltip' | 'tap_on_message_card_mode' | 'show_educational_message_card_right_swipe' | 'user_goal_complete' | 'hide_checklist' | 'show_message_card_swipe' | 'show_bulleted_summary_tooltip' | 'user_role_complete' | 'attribution_complete' | 'work_environment_complete' | 'conversations_workspace_complete' | 'team_workspace_complete' | 'send_first_message_complete' | 'pinned_cards' | 'hidden_playlists' | 'speed_dial_complete' | 'agent_setup_complete' | 'voice_memo_auto_copy' | 'voice_memo_link_prefix', required
    - `value` number, required
  - `string_preferences` StringUserPreferenceModel[]
    - `category` 'message_card' | 'onboarding' | 'playback' | 'recording' | 'label' | 'conversation_feed' | 'tooltips' | 'home', required
    - `name` 'speed' | 'auto_clear_notification' | 'auto_clear_compressed_audio_messages' | 'compress_text_messages' | 'compress_to_ai_summary' | 'show_ai_summary' | 'ai_summary_display_mode' | 'show_transcript' | 'identity_complete' | 'languages_complete' | 'suggested_conversations_complete' | 'streaming' | 'waiting_room' | 'default_id' | 'message_compression_character_limit' | 'message_compression_line_limit' | 'education_page_complete' | 'single_tap_to_record' | 'show_mic_tooltip' | 'show_create_conversation_tooltip' | 'show_create_a_folder_tooltip' | 'show_message_info_translate_button_tooltip' | 'show_chats_tab_tooltip' | 'tap_on_message_card_mode' | 'show_educational_message_card_right_swipe' | 'user_goal_complete' | 'hide_checklist' | 'show_message_card_swipe' | 'show_bulleted_summary_tooltip' | 'user_role_complete' | 'attribution_complete' | 'work_environment_complete' | 'conversations_workspace_complete' | 'team_workspace_complete' | 'send_first_message_complete' | 'pinned_cards' | 'hidden_playlists' | 'speed_dial_complete' | 'agent_setup_complete' | 'voice_memo_auto_copy' | 'voice_memo_link_prefix', required
    - `value` string, required

## Response `200`

- UserDto
  - `user_guid` string, required
  - `uuid` string, required
  - `first_name` string, nullable
  - `last_name` string, nullable
  - `image_url` string, required
  - `created_by` string, nullable
  - `role` string, nullable
  - `created_ts` number, required
  - `last_updated_ts` number, required
  - `last_seen_ts` number, required
  - `timezone_offset_minutes` number, required
  - `is_verified` string, required
  - `is_allowed_through_gate` boolean, required
  - `phone_txt` string, nullable
  - `email_txt` string, nullable
  - `workspace_guids` string[], required
  - `identities` UserIdentity[], required
    - `user_guid` string, required
    - `provider_email` string, nullable
    - `provider` string, nullable
    - `provider_uid` string, nullable
    - `image_url` string, nullable
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `is_verified` string, required
    - `provider_phone` string, nullable
  - `settings` object, required
  - `entries` UserEntryDto[], required
    - `entry_guid` string, required
    - `group_cd` 'CALLME' | 'EMAILME' | 'OTHER' | 'VIDEOME' | 'MESSAGEME' | 'SCHEDULEME' | 'COLLABORATE' | 'PAYME', required
    - `type_cd` string, required
    - `label_txt` string, required
    - `value_txt` string, required
    - `also_supports_mask` number, required
  - `last_seen_on` string, date-time, nullable
  - `plan_type` string, required
  - `notification_settings` NotificationSettings
    - `notify_by` NotifyBy, required
      - `DAILY_DIGEST` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `CONV_ADDED_NAMED` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `MSG_NEW` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `EMOTICON_RSP` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `MEET_NEW` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `MEET_UPDATE_CREATOR` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `MEET_UPDATE_MEMBER` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `MEET_ENDED` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `MEET_JOINED` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `WS_INVITE` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `WS_JOINED` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `WS_ADDED` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `ACTION_ITEM_ASSIGNED_TO_ME` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `ACTION_ITEM_DONE` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
      - `CHANNEL_REMINDER` NotifyByMethods
        - `email` boolean
        - `sms` boolean
        - `push` boolean
    - `primary_notification_email` string: Primary email notification (Will be used to send notifications)
    - `primary_notification_phone` string: Primary sms notification (Will be used to send notifications)
    - `product_notification_email` string: Primary Product email notification (Will be used to send product notifications)
    - `conversation_settings` ConversationSettings[]: Conversation Settings
      - `channel_id` string, required: Channel ID
      - `state` 'normal' | 'muted', required: Notification State
      - `sound_standard` string, nullable: Standard Message Sound
      - `sound_urgent` string, nullable: Urgent Message Sound
      - `sound_reply` string, nullable: Reply Message Sound
  - `environments` UserEnvironment[], required
    - `name` string, required
    - `apiUrl` string, required
    - `wsUrl` string, required
  - `languages` string[], required
  - `voice_gender` 'F' | 'M'
  - `voice_id` string, nullable
  - `has_fcm_token` boolean, required
  - `tts_mode` 'cloned_voice' | 'standard' | 'premium', required
  - `translation_mode` 'not_specified' | 'none' | 'tts' | 'dubbing', required
  - `preserve_senders_voice` boolean, required
  - `lifecycle_events` LifecycleEvent[], required
    - `type` 'Login' | 'UsedDiscussionLink' | 'IdentityAddded' | 'CreatedPlaylist' | 'CreatedWorkspace' | 'CreatedPersonalCarbonLink' | 'NotifiedMessageAccess' | 'VoiceMemoCreated' | 'ConversationMessageCreated' | 'DowngradedToLowerPlan' | 'AIResponseGenerated' | 'JoinedConversation' | 'JoinedWorkspace' | 'PersonalizedTTS' | 'DownloadedApp' | 'CheckedUsers' | 'SetPhoto' | 'InvitedUser' | 'WatchedGestureGuide' | 'WatchedWelcomeVideo', required
    - `times` number, required
  - `user_type` 'user' | 'bot' | 'agent', required
  - `is_agent` boolean, required
  - `owner_id` string, nullable, required

---

[API](https://skmtc.dev/carbonvoice/apis/carbon-voice-api.md) · [All operations](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/revisions/b91c5c845122?raw)