get https://api.mixmax.com/v1/userpreferences/me
Returns the current user's preferences
User preferences are key/value pairs stored for this user
Parameter | Type | Description |
---|---|---|
addUnsubscribeLinkToSequences | Boolean | Whether an unsubscribe link will be added to the bottom of sequence messages. Defaults to false . |
alwaysReplyFromDefaultAddress | Boolean | If user has multiple 'send from' accounts, this indicates that all replies should be from their default account. |
appHotkeyMac | String | The hotkey used to launch the compose window in the Mixmax app, if on Mac. Defaults to "Command+Shift+M" . |
appHotkeyWin | String | The hotkey used to launch the compose window in the Mixmax app, if on Windows. Defaults to "Control+Shift+M" . |
autoBccAddress | String | An email address that will also be auto-bcc'd when composing a message. Empty by default. |
autoBccExcludedDomains | String | If autoBccAddress used and the user is emailing an address in this comma-delimited list of domains, then the autoBccAddress will not be used. |
autoBccExcludedEmails | String | If autoBccAddress used and the user is emailing an address in this comma-delimited list of domains, then the autoBccAddress will not be used. |
autoLinkConversionEnabled | Boolean | Whether links pasted into the Mixmax message editor will automatically turn into link previews. Defaults to true . |
calendarAdditionalGuests | Array | Array of email addresses (strings) that will be added to all meeting invites, by default. |
calendarAppointmentSlots.linkEnabled | Boolean | Whether your public calendar link is enabled. Defaults to true . If disabled, the link will redirect to mixmax.com . |
calendarAppointmentSlots.limitMaxBookedSlots.enabled | Boolean | Whether to limit the maximum number of meetings booked per day with /cal , /lunch , and /meeting invites. Defaults to true . |
calendarAppointmentSlots.limitMaxBookedSlots.perDay | Number | Max number of booked slots per day if enabled is true . After max is reached, no meetings are allowed with /cal , /lunch , or /meeting . Defaults to 6 . |
calendarAvailabilityDescription | String | The default text to use for the description in new availability invites. |
calendarAvailabilityLocation | String | The default text to use for the location in new availability invites. |
calendarAvailabilityTitle | String | The default text to use for the title in new availability invites. |
calendarDragChunkingEnabled | Boolean | Whether to enable dragging to create multiple meetings (versus one) in the meeting invite view. Defaults to true . |
calendarEventDescription | String | The default text to use for the description in new event invites. |
calendarEventLocation | String | The default text to use for the location in new event invites. |
calendarEventTitle | String | The default text to use for the title in new event invites. |
calendarHourFormatAMPM | Boolean | true to use 12-hour time, false to use 24-hour time. |
defaultAttachmentsType | String | Either "traditional" or "cloud" - the default type of attachment to use when dragging files into the message editor. Defaults to "traditional" . |
defaultAutoSyncToTeamFeed | Boolean | Whether to sync new emails to the Team Live Feed by default. Defaults to false . |
defaultShowContentTeamFeed | Boolean | Whether team members can view the emails that sync to Mixmax. |
defaultCRMsConnected | Array | CRMs that are connected to this account. Array of objects, each with keys name and other attributes (eg logX ) specific to that CRM. |
defaultComposeStateNew | String | Message editor style when clicking the compose button in Gmail. One of: "mole" , "modal" , or "window" . Defaults to "mole" . |
defaultComposeStateReply | String | Message editor style when clicking the reply button in Gmail. One of: "mole" , "modal" , or "inline" . Defaults to "inline" . |
defaultDashboardNavDrawerWidth | String | Whether the dashboard left side navigation is open or collapsed. One of: "wide" , "narrow" . Defaulted to "wide" . |
defaultFollowup | Object | The default reminder for a new message, if set. Has keys unparsedDate , trigger , and autoRemind . |
defaultFontFamily | String | Default font family to use in the message editor. |
defaultFontName | String | Default font name to use in the message editor. Defaults to "standard" . |
defaultFontNameDisplay | String | Cached name of the default font name. Defaults to "Standard" . |
defaultFontSize | String | Default size of font, in HTML element names. Defaults to "small" . |
defaultLinkTrackingEnabled | Boolean | Whether to turn link tracking on by default. Defaults to false . |
defaultLocation | String | The value with which the {{host location}} variable is replaced. |
defaultLogToAutoBcc | Boolean | Whether to BCC the autoBccAddress address by default. Defaults to false . |
defaultMeetingLength | Number | Default meeting length, in milliseconds, when sending availability. Defaults to 1800000 (30 minutes). |
defaultNakedLinkTrackingEnabled | Boolean | Whether to track "naked" links (matching link text and url) by default. Defaults to false . |
defaultNarrowWidthEnabled | Boolean | Whether to limit message width to 600px. Defaults to false . |
defaultNotificationsEnabled | Boolean | Whether to turn on desktop notifications for notifications. Defaults to false . |
defaultSilentReminders | Boolean | Whether to bring threads to the top of the inbox and mark them unread without sending a new email (if possible). |
defaultTrackingEnabled | Boolean | Whether to turn on email open tracking by default. Defaults to true . |
emojiEnabled | Boolean | Whether to enable auto-conversion of emojis when typing in the editor. Defaults to true . |
enableTrackingIndicatorsInGmail | Boolean | Enables tracking indicators in Gmail/Inbox. Defaults to true . |
followupPresets | Object | Object of followup and scheduled email preset times to use. |
hideVisibleCalendarsSidebar | Boolean | Whether to hide the calendar sidebar when selecting availability. Defaults to false . |
inlinePDFPreviewEnabled | Boolean | Whether to generate slideshow previews of PDFs when they're attached. Defaults to true . |
preventDoubleBookings | Boolean | Whether to prevent double bookings by default when selecting availability. Defaults to true . |
salesforceFieldsSettings | Object | Determines which team you are sharing salesforce sidebar fields with. null if you are using your own settings. |
selectedCalendarId | String | The last selected calendar when proposing availability. |
selectedSidebar | String | The last selected sidebar in Gmail. |
sendAndArchiveEnabled | Boolean | Whether the user has "Send and Archive" enabled. |
sendFromAccounts | Array | Array of email aliases that the user can send from. |
sidebarEnabled | Boolean | False to disable the Mixmax sidebar in Gmail and Inbox. Defaults to true . |
signatureBeforeQuotedText | Boolean | Whether the user's signature shows up before the quoted text when replying. Defaults to true . |
signatures | Array | User signatures per account. |
slashCommandMenuEnabled | Boolean | Whether typing / in the message editor will bring up the slash command menu. Defaults to true . |
slashLunch.endTime | String | End time of your lunch period. Used by /lunch command to suggest meetings during your lunch period. Format must match "HH:mm:ss" . Defaults to "13:00:00" . |
slashLunch.slots | Number | Number of lunch slots to suggest with the /lunch command. Defaults to 4 . |
slashLunch.startTime | String | Start time of your lunch period. Used by /lunch command to suggest meetings during your lunch period. Format must match "HH:mm:ss" . Defaults to "12:00:00" . |
slashMeeting.slots | Number | Number of meeting slots to suggest with the /meeting command. Override by typing /meeting [duration] [slots] . Defaults to 12 . |
templateShortcutMenuEnabled | Boolean | Whether typing ; in the message editor will show the template menu. Defaults to true . |
theme | String | The color theme to use in Mixmax. Defaults to "gmail" . |
undoDelay | Number | Undo delay time in seconds. Default is 0 (no undo). |
undoSendEnabled | Boolean | True if undo send is enabled. Defaults to false . |
userId | String | Your user ID |
visibleCalendars | Object | List of calendars that are checked when proposing availability. |
weekStartDay | Number | Day of week (Sunday == 0 ) that the week starts. Defaults to 0 . |
defaultCalendarType | String | The ID of a user's default meeting template, or "NO_DEFAULT" if none is chosen. Used to populate the {{sender calendar url}} variable. |