Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cometchat-22654f5b-docs-android-v6-beta2.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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

MethodEndpointDescription
GET/apps/{appId}/settingsList all settings for the app
POST/apps/{appId}/settingsMap (update) settings for the app
DELETE/apps/{appId}/settingsUnmap (reset) settings for the app

Available settings

KeyDescriptionDefault
core.conversations.updateOnGroupActionsWhether group actions (member joined, left, banned) appear as the last message and increment unread count.true
core.conversations.updateOnRepliesWhether thread replies appear as the last message. Thread replies do not increment the unread count.true
core.conversations.updateOnMessageActionsWhether message actions (edited, deleted) appear as the last message and increment unread count.false
core.conversations.updateOnCallActivityWhether call activities (initiated, accepted, rejected) appear as the last message and increment unread count.false
core.threads.updateOnMessageActionsWhether thread message actions (edited, deleted) appear as the last message and increment unread count.false
core.notifications.push.enabledWhether 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 CodeDescription
AUTH_ERR_EMPTY_APIKEYThe apikey header is missing from the request
AUTH_ERR_APIKEY_NOT_FOUNDThe provided API key is invalid
AUTH_ERR_NO_ACCESSThe API key doesn’t have the required scope
For the complete error reference, see Error Guide.