Retrieve gamification settings
/settings/gamificationReturns 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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/settings/gamification"{ "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 } } }}Update embedded page settings PATCH
Updates the embedded page settings. Only the fields included in the request are changed: setting a field to `null` clears its configured value and restores the default, and omitted fields are left unchanged. `home_url` and `first_access_url` must use the HTTP or HTTPS scheme. 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.
Update gamification settings PATCH
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.