Sign in
User

Update Notification Setting

Update a notification delivery preference.

The API accepts the legacy dont_notify flag and stores the inverse as the user's delivery preference for the requested notification type and channel.

put/api/v1/notification_setting

Request body

notification_type'note_added' | 'item_assigned' | 'item_completed' | 'item_uncompleted' | 'karma_level' | 'share_invitation_sent' | 'share_invitation_accepted' | 'share_invitation_rejected' | 'share_invitation_blocked_by_project_limit' | 'user_left_project' | 'user_removed_from_project' | 'teams_workspace_upgraded' | 'teams_workspace_canceled' | 'teams_workspace_payment_failed' | 'pro_trial_started' | 'pro_trial_ended' | 'workspace_invitation_created' | 'workspace_invitation_accepted' | 'workspace_invitation_rejected' | 'project_archived' | 'project_moved' | 'removed_from_workspace' | 'workspace_deleted' | 'message' | 'workspace_user_joined_by_domain' | 'price_increase_new_pro_users' | 'price_increase_new_team' | 'price_increase_new_team_trial' | 'price_increase_android' | 'workspace_team_cohort_tagged' required

The type of notification being sent

service'email' | 'push' required

Which communication mechanism is being used to send this notification

dont_notifyboolean nullable

Whether notifications should be disabled for the selected type and channel.

Example request

{
  "dont_notify": true
}

Response

Successful Response

object required

Notification delivery preferences keyed by notification type.

Example response

{
  "user_left_project": {
    "notify_push": true,
    "notify_email": true
  }
}

Changes

No recorded changes to this endpoint across all 10 revisions of this API.