Developers
General settings

Update gamification settings

PATCH/settings/gamification

Updates the gamification settings. Only the fields included in the request are changed, and triggers omitted from triggers are left unchanged.

A trigger's points value must be at least 1. To stop a trigger from awarding points, set its enabled field to false.

Requires the gamification.update permission. To avoid overwriting a newer version, send the ETag returned by the retrieve operation in the If-Match header. The header is optional; when it is omitted, the update is applied to the current revision.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Header Parameters

If-Match?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/settings/gamification" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "comment_scoring": "once",    "defaults": {},    "enabled": true,    "object": "settings",    "replica": {},    "revision": "string",    "show_full_name": true,    "show_to_students": true,    "triggers": {      "property1": {        "enabled": true,        "points": 1      },      "property2": {        "enabled": true,        "points": 1      }    }  }}

Retrieve gamification settings GET

Returns the gamification settings of the account: ranking visibility, the scoring rule for comments, and the triggers that award points. Requires the `gamification.read` permission; `settings.read` does not grant access to this group. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating these settings to avoid overwriting a newer version.

Retrieve platform settings GET

Returns the platform settings of the account, such as language, title, showcase layout, dark mode, font size, sidebar visibility, and footer options. The `defaults` object contains the default values, which lets you distinguish configured values from defaults. The `revision` field identifies the current revision of the settings. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating these settings to avoid overwriting a newer version.