Update comment settings
/settings/support/commentsUpdates the lesson comment settings. Only the fields included in the request are changed; omitted fields are left unchanged.
Setting moderation_enabled to false publishes every comment in the account that is pending moderation. The number of comments published is returned in effects.approved_pending_comments.
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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Header Parameters
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/support/comments" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "cooldown_minutes": 0, "defaults": {}, "enabled": true, "min_length": 0, "moderation_enabled": true, "object": "settings", "open_in_new_tab": true, "placeholder": "string", "revision": "string", "sort": "newest", "tags_enabled": true, "title": "string" }, "effects": { "approved_pending_comments": 0 }}Retrieve comment settings GET
Returns the lesson comment settings of the account: availability, moderation, tags, texts displayed to users, sort order, and posting limits. 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 FAQ settings GET
Returns the settings of the FAQ section in the student area: availability, title, and text. 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.