Skip to main content
DELETE
/
users
/
{uid}
/
friends
Remove Friends
curl --request DELETE \
  --url https://{appId}.api-{region}.cometchat.io/v3/users/{uid}/friends \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "friends": [
    "<string>"
  ]
}
'
{
  "data": {
    "success": true,
    "message": "Deleted the friend relations succussfully"
  }
}
For the complete error reference, see Error Guide.

Authorizations

​
apikey
string
header
required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Path Parameters

​
uid
string
required

An UID of a user.

Body

application/json
​
friends
string[]

The array of friends to remove.

Response

200 - application/json

A list of api keys

​
data
object