Unregister users

Unregister one or more user accounts that no longer use the OpenIM service. This endpoint is available only in OpenIM Enterprise. Configure the API address and a valid token as described in Prepare to use the API.

HTTP request

POST {API_ADDRESS}/user/unregister_user

Request example

curl --request POST "${API_ADDRESS}/user/unregister_user" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${TOKEN}" \
  --data-raw '{
  "userIDs": ["user_001"]
}'

Enterprise: This endpoint requires the corresponding OpenIM Enterprise services. Availability and permissions depend on the delivered version.

Request body

{
  "userIDs": ["user_001"]
}

Response

A normally processed request typically returns 200 OK. Check errCode in the response body to determine whether the operation succeeded.

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

Response properties

Errors

Error responses use the common Platform API structure. See Error codes.

Permissions and limits

• Available only in OpenIM Enterprise.
• The caller must validate its authority over the target users.
• Request array limits follow the limits of the delivered server version.

Related pages

• Prepare to use the API
• User overview
• Error codes