Skip to main content
POST
/
users
/
{uid}
/
friends
Add Friends
curl --request POST \
  --url https://{appid}.api-{region}.cometchat.io/v3/users/{uid}/friends \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "accepted": [
    "<string>"
  ],
  "addToConversations": false
}
'
{
  "data": {
    "accepted": {
      "superhero2": {
        "success": true,
        "message": "Created relationship with status accepted."
      },
      "superhero3": {
        "success": true,
        "message": "Created relationship with status accepted."
      }
    }
  }
}

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
​
accepted
string[]

The array of UIDs of the friends.

​
addToConversations
boolean
default:false

When enabled, automatically creates chat conversations between users when they become friends.

Response

200 - application/json

Added Friend

​
data
object