invite-to-channel.md

Invite to Channel

Adds a user or bulk users to the channel.

HTTP Method	URL	Requires Auth
POST	/api/v1/channels.invite	yes

{% hint style="info" %} For a user to invite others, they must match at least one of the following premises:

• If the user is part of a room of any type and has the add-user-to-joined-room permission.
• If the user is part of a public room (t: 'c') and has the add-user-to-any-c-room permission.
• If the user is part of a private room (t: 'p') and has the add-user-to-any-p-room permission. {% endhint %}

Add a user

Body Parameters

Key	Example Value	Description
roomId*	ByehQjC44FwMeiLbX	The channel ID.
userId*	nSYqWzZ4GsKTX4dyK	The user ID to invite to the channel.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     https://localhost:3000/api/v1/channels.invite \
     -d '{ 
          "roomId": "ByehQjC44FwMeiLbX", 
          "userId": "nSYqWzZ4GsKTX4dyK" }'

Example Response

{
  "channel": {
    "_id": "ByehQjC44FwMeiLbX",
    "ts": "2016-11-30T21:23:04.737Z",
    "t": "c",
    "name": "testing",
    "usernames": "testing",
    "msgs": 1,
    "_updatedAt": "2016-12-09T12:50:51.575Z",
    "lm": "2016-12-09T12:50:51.555Z"
  },
  "success": true
}

Add bulk users

Body Parameters

Key	Example Value	Description
roomId*	ByehQjC44FwMeiLbX	The channel ID.
userIds*	["nSYqWzZ4GsKTX4dyK", "SYqWzZ4Gsasdfgh"]	The user IDs of the users to invite to the channel

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/channels.invite \
     -d '{ 
          "roomId": "ByehQjC44FwMeiLbX", 
          "userIds": ["nSYqWzZ4GsKTX4dyK", "SYqWzZ4Gsasdfgh"]}'

Example Response

{
  "channel": {
    "_id": "ByehQjC44FwMeiLbX",
    "ts": "2016-11-30T21:23:04.737Z",
    "t": "c",
    "name": "testing",
    "usernames": [
      "testing",
      "testing1"
    ],
    "msgs": 1,
    "_updatedAt": "2016-12-09T12:50:51.575Z",
    "lm": "2016-12-09T12:50:51.555Z"
  },
  "success": true
}

Change Log

Version	Description
0.48.0	Added