Clear the group application badge count

Clear the group-application badge count currently stored for a user. This endpoint is available only in OpenIM Enterprise.

HTTP request

POST {API_ADDRESS}/group/clear_group_application_badge_count

Request example

curl --request POST "${API_ADDRESS}/group/clear_group_application_badge_count" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${TOKEN}" \
  --data-raw '{"userID":"user_001"}'

Enterprise: This endpoint requires the corresponding OpenIM Enterprise services.

Request body

Response

The API returns the common response envelope. errCode is 0 when the count was cleared successfully.

{"errCode":0,"errMsg":"","errDlt":""}

Errors

See Error codes.

Permissions and limits

• Available only in OpenIM Enterprise.
• The caller must validate its authority to update the user's application state.

Related pages

• Group overview
• Get the group application badge count