Browse Platform API
Platform APIEnterprise

Delete applications received by a group

Copy

Delete selected join-application records received by a group. This endpoint is available only in OpenIM Enterprise.

HTTP request

POST {API_ADDRESS}/group/delete_group_requests_to_group

Request example

curl --request POST "${API_ADDRESS}/group/delete_group_requests_to_group" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${TOKEN}" \
  --data-raw '{"groupID":"group_001","userIDs":["user_001"]}'
Enterprise: This endpoint requires the corresponding OpenIM Enterprise services.

Request body

ParameterRequiredTypeDescription
groupIDYesstringGroup that received the applications.
userIDsYesstring[]Applicants whose records are deleted.

Response

The API returns the common response envelope. errCode is 0 when the records were deleted successfully.

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

Errors

See Error codes.

Permissions and limits

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