/userpreferences/me

patch

https://api.mixmax.com/v1/userpreferences/me

Sets the preference keys in the body and returns them as sent. Keys you leave out are not changed. _id and userId are ignored.

Keys are not checked against a list: any key you send is stored, so check spelling. Only undoDelay (a number from 2 to 30), undoSendEnabled (a boolean) and autoBccAddress (a valid email address) are validated.

A setting your workspace role manages (see the GET operation) is still saved, but reads keep returning the role's value until the role lets you manage it.

Errors come back as 400 with a plain-text body, not JSON.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Your preference keys. New accounts start with the defaults shown; older accounts may lack some keys. Other keys exist and are returned as stored.

defaultTrackingEnabled

boolean

Defaults to true

Whether email open tracking is on by default for new messages.

defaultLinkTrackingEnabled

boolean

Defaults to false

Whether link click tracking is on by default.

defaultNakedLinkTrackingEnabled

boolean

Defaults to false

Whether links whose text is the URL itself are tracked by default.

defaultFileTrackingEnabled

boolean

Defaults to false

Whether file download tracking is on by default.

defaultNotificationsEnabled

boolean

Defaults to false

Whether desktop notifications are on by default.

enableTrackingIndicatorsInGmail

boolean

Defaults to true

Whether tracking indicators show in Gmail.

undoSendEnabled

boolean

Defaults to true

Whether undo send is on.

undoDelay

number

2 to 30

Defaults to 5

How many seconds you have to undo a send. Must be between 2 and 30.

defaultFontSize

string

Defaults to small

Default font size in the message editor, as an HTML size name.

defaultFontName

string

Default font in the message editor.

defaultFontFamily

string

Default CSS font family in the message editor.

defaultNarrowWidthEnabled

boolean

Defaults to false

Whether message width is limited to 600px.

defaultLocation

string

The value used for the {{host location}} variable.

emojiEnabled

boolean

Defaults to true

Whether emoji shortcuts are converted while typing in the editor.

slashCommandMenuEnabled

boolean

Defaults to true

Whether typing / in the editor opens the slash command menu.

templateShortcutMenuEnabled

boolean

Defaults to true

Whether typing ; in the editor opens the template menu.

autoLinkConversionEnabled

boolean

Defaults to true

Whether pasted links turn into link previews.

inlinePDFPreviewEnabled

boolean

Defaults to false

Whether attached PDFs get a slideshow preview.

defaultAttachmentsType

string

enum

Whether files dragged into the editor attach normally or as cloud links.

Allowed:

signatureBeforeQuotedText

boolean

Defaults to false

Whether your signature goes above the quoted text in replies.

signatures

array of objects

Your signature for each address you send from.

signatures

sendFromAccounts

array of objects

The addresses and aliases you can send from.

sendFromAccounts

includeSentWithMixmax

boolean

Defaults to true

Whether sent emails include "Sent with Mixmax" branding.

autoBccAddress

string

An address to BCC on messages you send. Must be a valid email address.

defaultLogToAutoBcc

boolean

Defaults to false

Whether autoBccAddress is BCC'd by default.

autoBccExcludedDomains

string

Comma-separated domains that never get the auto BCC. New Google Workspace accounts start with their own domain. Can be managed by your workspace role.

autoBccExcludedEmails

array of objects

Addresses that never get the auto BCC. Can be managed by your workspace role.

autoBccExcludedEmails

addUnsubscribeLinkToSequences

boolean

Defaults to false

Whether an unsubscribe link is added to sequence emails. Can be managed by your workspace role.

defaultAutoSyncToTeamFeed

boolean

Defaults to false

Whether new emails sync to the team live feed by default. Can be managed by your workspace role.

defaultFollowup

object

The default reminder for new messages.

followupPresets

object

The time choices offered for reminders and send later.

defaultMeetingLength

int64

Defaults to 1800000

Default meeting length in milliseconds when sharing availability.

defaultCalendarType

string

The id of your default meeting template, used for the {{sender calendar url}} variable.

preventDoubleBookings

boolean

Defaults to true

Whether double bookings are prevented by default when sharing availability.

calendarHourFormatAMPM

boolean

true for 12-hour time, false for 24-hour time. New accounts get this from their locale.

weekStartDay

integer

The first day of the week, where Sunday is 0. New accounts get this from their locale.

calendarDragChunkingEnabled

boolean

Defaults to true

Whether dragging in the availability view creates several slots instead of one.

calendarAdditionalGuests

array of strings

Email addresses added to every meeting invite.

calendarAdditionalGuests

calendarAppointmentSlots

object

Settings for your scheduling page.

slashMeeting

object

workHours

object

Your working hours, with keys day0 (Sunday) to day6. Each day has enabled and a timeslots list of startTime and endTime strings in HH:mm:ss.

sidebarEnabled

boolean

Defaults to true

Whether the Mixmax sidebar shows in Gmail.

appHotkeyMac

string

Defaults to Command+Shift+M

The shortcut that opens the compose window in the Mixmax app on Mac.

appHotkeyWin

string

Defaults to Control+Shift+M

The shortcut that opens the compose window in the Mixmax app on Windows.

defaultDashboardNavDrawerWidth

string

enum

Defaults to wide

Whether the dashboard side navigation is open or collapsed.

Allowed:

defaultCRMsConnected

array of objects

Your CRM logging settings. Each object has a name such as salesforce and that CRM's own options.

defaultCRMsConnected

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200The keys that were saved, as sent, without _id and userId.

400A value failed validation. The body is plain text.

403The request used an admin-managed API key. This endpoint accepts only personal API tokens. A key limited to specific scopes is refused with This API does not support scoped credentials, and a key with the * scope with This API does not support managed API credentials yet.