Overview - CometChat Docs

The Settings API lets you customize how conversations behave in your CometChat app. You can control which message types appear as the last message in a conversation and which ones increment the unread message count.

Endpoints

Method	Endpoint	Description
GET	`/apps/{appId}/settings`	List all settings for the app
POST	`/apps/{appId}/settings`	Map (update) settings for the app
DELETE	`/apps/{appId}/settings`	Unmap (reset) settings for the app

Available settings

Key	Description	Default
`core.conversations.updateOnGroupActions`	Whether group actions (member joined, left, banned) appear as the last message and increment unread count.	`true`
`core.conversations.updateOnReplies`	Whether thread replies appear as the last message. Thread replies do not increment the unread count.	`true`
`core.conversations.updateOnMessageActions`	Whether message actions (edited, deleted) appear as the last message and increment unread count.	`false`
`core.conversations.updateOnCallActivity`	Whether call activities (initiated, accepted, rejected) appear as the last message and increment unread count.	`false`
`core.threads.updateOnMessageActions`	Whether thread message actions (edited, deleted) appear as the last message and increment unread count.	`false`
`core.notifications.push.enabled`	Whether Enhanced Push Notifications are enabled for the app.	`false`

How settings connect to other resources

Conversations — These settings directly control how Conversations display the last message and calculate unread counts.
Messages — Settings determine which Message types affect conversation previews.
Management APIs — Use the Map Settings API to toggle these features.

Error Handling

Error Code	Description
`AUTH_ERR_EMPTY_APIKEY`	The `apikey` header is missing from the request
`AUTH_ERR_APIKEY_NOT_FOUND`	The provided API key is invalid
`AUTH_ERR_NO_ACCESS`	The API key doesn’t have the required scope

For the complete error reference, see Error Guide.

​Endpoints

​Available settings

​How settings connect to other resources

​Error Handling

Endpoints

Available settings

How settings connect to other resources

Error Handling