Change the direct-message and digest settings of a community
PATCH /api/communities/{communityId}/settings. Change the direct-message and digest settings of a community. Headless LMS Communities API reference.
Requires communities:write. Changes only the settings sent; the rest keep their values. The direct-message settings decide who may message whom from then on. digest sets when the community digest goes out, or null stops it; the first digest after a change goes out at the next slot.
Path Parameters
communityId*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
application/json
curl -X PATCH "https://example.com/api/communities/string/settings" \ -H "Content-Type: application/json" \ -d '{}'{ "orgId": "string", "id": "string", "type": "community", "title": "string", "slug": "string", "description": "string", "status": "draft", "thumbnailAssetId": "string", "settings": { "dm": { "enabled": true, "memberToMember": true, "memberToTeam": true, "teamToAnyone": true, "firstMessageIsRequest": true, "groupChats": true, "groupSize": 1 }, "digest": { "cadence": "daily", "weekday": 0, "hour": 0, "timeZone": "string" } }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "thumbnailUrl": "string"}{ "error": "string", "message": "string", "requestId": "string", "issues": [ { "path": "string", "message": "string" } ]}{ "error": "string", "message": "string", "requestId": "string"}{ "error": "string", "message": "string", "requestId": "string"}{ "error": "string", "message": "string", "requestId": "string"}{ "error": "string", "message": "string", "requestId": "string"}