Update a user's preferences

Update a user’s notification and streak preferences. Streak preferences require streak customization to be enabled in your Trophy dashboard settings.

PATCH /users/{id}/preferences

JavaScript

JavaScript

import { TrophyApiClient } from '@trophyso/node';

const trophy = new TrophyApiClient({
  apiKey: 'YOUR_API_KEY'
});

const response = await trophy.users.updatePreferences("user-123", {
  notifications: {
    recap: ["email"],
    streak_reminder: []
  }
});

from trophy import TrophyApi

client = TrophyApi(api_key='YOUR_API_KEY')

response = client.users.update_preferences(
  id="user-123",
  notifications={
    "recap": ["email"],
    "streak_reminder": []
  }
)

import (
  "context"

  api "github.com/trophyso/trophy-go"
  trophyclient "github.com/trophyso/trophy-go/client"
  "github.com/trophyso/trophy-go/option"
)

client := trophyclient.NewClient(
  option.WithApiKey("YOUR_API_KEY"),
)

response, err := client.Users.UpdatePreferences(
  context.TODO(),
  "user-123",
  &api.UpdateUserPreferencesRequest{},
)

curl --request PATCH \
  --url https://api.trophy.so/v1/users/{id}/preferences \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "notifications": {
    "streak_reminder": []
  }
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trophy.so/v1/users/{id}/preferences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'notifications' => [
        'streak_reminder' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://api.trophy.so/v1/users/{id}/preferences")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"notifications\": {\n    \"streak_reminder\": []\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trophy.so/v1/users/{id}/preferences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"notifications\": {\n    \"streak_reminder\": []\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "notifications": {
    "achievement_completed": [
      "email",
      "push"
    ],
    "recap": [
      "email"
    ],
    "reactivation": [
      "email",
      "push"
    ],
    "streak_reminder": []
  },
  "streak": {
    "evaluationMode": "OR",
    "metrics": [
      {
        "key": "words-written",
        "threshold": 500
      }
    ]
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

X-API-KEY · string · header · required

Headers

Tenant-ID · string

The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. The value should be your internal ID for the tenant. Ignored for single-tenant organisations.

Path Parameters

id · string · required

The user's ID in your database.

Body

application/json

Request body for updating user preferences.

notifications · NotificationPreferences · object

Notification preferences for each notification type.

Show child attributes

streak · StreakPreferences · object

Per-user streak configuration. Metric and evaluation mode overrides require streak customization to be enabled in dashboard settings.

Show child attributes

Response

200

application/json

Successful operation

A user's preferences.

notifications · NotificationPreferences · object · required

Notification preferences for each notification type.

Show child attributes

streak · StreakPreferences · object

Per-user streak configuration. Metric and evaluation mode overrides require streak customization to be enabled in dashboard settings.

Show child attributes