STstreakyc
Users

Update user settings

Changed on

Updates the supplied settings fields. Omitted fields remain unchanged. Specifying an individual field as null resets it to its default value.

post/v2/users/me/settings

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v2/users/me/settings
  • Auth
    HTTP bearer

Request body

streakItboolean nullable

Show the Add To Box button on Gmail thread rows.

listIndicatorTypeListIndicator[] nullable

Information shown in the box indicator on Gmail thread rows.

pixelTrackingDefaultOnboolean nullable

Turn on email tracking by default for new emails.

snippetAutoCompleteboolean nullable

Autocomplete snippets in compose.

pipelineSharedNotificationChannel[] nullable

Notify when a pipeline is shared with the user.

followedBoxboolean nullable

Notify about changes to boxes the user follows or is assigned to. When false, all followedBox* notifications are off.

followedBoxStageChangeNotificationChannel[] nullable

Notify when a followed box changes stage. Ignored while followedBox is false.

followedBoxNewCommentNotificationChannel[] nullable

Notify about new comments on followed boxes. Ignored while followedBox is false.

followedAssignedToMeNotificationChannel[] nullable

Notify when a box or task is assigned to the user. Ignored while followedBox is false.

followedAssignedToSelfNotificationChannel[] nullable

Notify when the user assigns a box or task to themselves. Ignored while followedBox is false.

followedBoxDataChangeNotificationChannel[] nullable

Notify about data changes on followed boxes. Ignored while followedBox is false.

anyBoxboolean nullable

Notify about changes to all other boxes the user can access. When false, all anyBox* notifications are off.

anyBoxStageChangeNotificationChannel[] nullable

Notify when any box changes stage. Ignored while anyBox is false.

anyBoxNewCommentNotificationChannel[] nullable

Notify about new comments on any box. Ignored while anyBox is false.

anyBoxDataChangeNotificationChannel[] nullable

Notify about data changes on any box. Ignored while anyBox is false.

newBoxNotificationChannel[] nullable

Notify when a new box is created.

tasksNotificationChannel[] nullable

Notify when tasks are due.

tasksCompletedNotificationChannel[] nullable

Notify when others complete tasks the user created.

meetingsNotificationChannel[] nullable

Notify about new call logs and meeting notes.

importJobStatusNotificationChannel[] nullable

Notify when a pipeline import completes.

firstTrackedThreadReadNotificationChannel[] nullable

Notify the first time a tracked email is read.

firstTrackedThreadClickNotificationChannel[] nullable

Notify the first time a tracked email is clicked.

Response

OK

streakItboolean

Show the Add To Box button on Gmail thread rows.

listIndicatorTypeListIndicator[] required

Information shown in the box indicator on Gmail thread rows.

pixelTrackingDefaultOnboolean

Turn on email tracking by default for new emails.

snippetAutoCompleteboolean

Autocomplete snippets in compose.

pipelineSharedNotificationChannel[] required

Notify when a pipeline is shared with the user.

followedBoxboolean

Notify about changes to boxes the user follows or is assigned to. When false, all followedBox* notifications are off.

followedBoxStageChangeNotificationChannel[] required

Notify when a followed box changes stage. Ignored while followedBox is false.

followedBoxNewCommentNotificationChannel[] required

Notify about new comments on followed boxes. Ignored while followedBox is false.

followedAssignedToMeNotificationChannel[] required

Notify when a box or task is assigned to the user. Ignored while followedBox is false.

followedAssignedToSelfNotificationChannel[] required

Notify when the user assigns a box or task to themselves. Ignored while followedBox is false.

followedBoxDataChangeNotificationChannel[] required

Notify about data changes on followed boxes. Ignored while followedBox is false.

anyBoxboolean

Notify about changes to all other boxes the user can access. When false, all anyBox* notifications are off.

anyBoxStageChangeNotificationChannel[] required

Notify when any box changes stage. Ignored while anyBox is false.

anyBoxNewCommentNotificationChannel[] required

Notify about new comments on any box. Ignored while anyBox is false.

anyBoxDataChangeNotificationChannel[] required

Notify about data changes on any box. Ignored while anyBox is false.

newBoxNotificationChannel[] required

Notify when a new box is created.

tasksNotificationChannel[] required

Notify when tasks are due.

tasksCompletedNotificationChannel[] required

Notify when others complete tasks the user created.

meetingsNotificationChannel[] required

Notify about new call logs and meeting notes.

importJobStatusNotificationChannel[] required

Notify when a pipeline import completes.

firstTrackedThreadReadNotificationChannel[] required

Notify the first time a tracked email is read.

firstTrackedThreadClickNotificationChannel[] required

Notify the first time a tracked email is clicked.

Changes