Invite Users to Group

Invite one user or bulk users to the group/channel.

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

Invite a user

Body Parameters

Key	Example Value	Description
roomId*	ByehQjC44FwMeiLbX	The group ID.
userId*	nSYqWzZ4GsKTX4dyK	The user ID of the invited user.

Example Call

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

Example Response

{
  "group": {
    "_id": "ByehQjC44FwMeiLbX",
    "ts": "2016-11-30T21:23:04.737Z",
    "t": "p",
    "name": "testing",
    "username": "testing",
    "u": {
        "_id": "aobEdbYhXfu5hkeqG",
        "username": "testing1"
    },
    "msgs": 1,
    "_updatedAt": "2016-12-09T12:50:51.575Z",
    "lm": "2016-12-09T12:50:51.555Z"
  },
  "success": true
}

Invite bulk users

Body Parameters

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

Example Call

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

Example Response

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

Error

If you are an administrator and try to invite a user to a group, of which you are not a member, then you will get an error:

{
  "success": false,
  "error": "Not allowed [error-not-allowed]",
  "errorType": "error-not-allowed",
  "details": {
    "method": "addUsersToRoom"
  }

Change Log

Version	Description
0.48.0	Added