Skip to main content
POST
/
streaks
/
restore
JavaScript
import { TrophyApiClient } from '@trophyso/node';

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

const response = await trophy.admin.streaks.restore({
  users: [{ id: 'user-123' }, { id: 'user-456' }]
});
{
  "restoredUsers": [
    "user-123",
    "user-456"
  ],
  "issues": []
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Array of users to restore streaks for

Request body for restoring streaks for multiple users.

​
users
object[]
required

Array of users to restore streaks for. Maximum 100 users per request.

Required array length: 1 - 100 elements
Example:
[{ "id": "user-123" }, { "id": "user-456" }]

Response

Successful operation

Response containing restored users and any issues encountered.

​
restoredUsers
string[]
required

Array of user IDs whose streaks were successfully restored.

Example:
["user-123", "user-456"]
​
issues
BulkInsertIssue · object[]
required

Array of issues encountered during streak restoration.