Platform APIEnterprise
Delete sent friend requests
Delete selected friend-request records sent by a user. This endpoint is available only in OpenIM Enterprise.
HTTP request
POST {API_ADDRESS}/friend/delete_friend_requests_from_userRequest example
curl --request POST "${API_ADDRESS}/friend/delete_friend_requests_from_user" \
--header "Content-Type: application/json; charset=utf-8" \
--header "operationID: ${OPERATION_ID}" \
--header "token: ${TOKEN}" \
--data-raw '{"fromUserID":"user_001","toUserIDs":["user_002"]}'Enterprise: This endpoint requires the corresponding OpenIM Enterprise services. Availability and permissions depend on the delivered version.
Request body
| Parameter | Required | Type | Description |
|---|---|---|---|
| fromUserID | Yes | string | User ID of the request sender. |
| toUserIDs | Yes | string[] | User IDs of the request recipients 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 for the common error structure.
Permissions and limits
- Available only in OpenIM Enterprise.
- The caller must validate its authority over the request sender.
- Request array limits follow the delivered server version.
Related pages
Was this page helpful?