Room/Page invite user api

The "room invite" API allows a user to invite another user to join a group/page. The invited user will receive a notification and can choose to accept or decline the invitation.

Path Parameters

group_id string required

room/page id

Header Parameters

access-token string required

access token for room admin user

client string required

client token

expiry string required
timestamp of token expiry
Example: 1531315250
token-type string required
access token type
Example: Bearer
uid string required
user uid
Example: user@quranreflect.com

application/json

Request Body

user_id integer

Invite existing user using id

email string

Or you can also invite user using email

Responses

• 200

---

OK

Response Headers

application/json

Schema

Example (from schema)

example-0

example-1

example-2

example-3

example-4

---

Schema

success boolean

value will be true if invitation was sent, false othewise

message string

{
  "success": true,
  "message": "string"
}

Gorup invite User API (success true by username)

{
  "success": true,
  "message": "User samerabbas was invited successfully to group testmego123"
}

Gorup invite User API (already member)

{
  "success": false,
  "message": "User samerabbas is already a member of testmego123"
}

Gorup invite User API (wrong user info)

{
  "success": false,
  "message": "Can not find user with username hi55"
}

Gorup invite User API (invalid email)

{
  "success": false,
  "message": "Can't invite user with invalid email"
}

Gorup invite User API (succes true by email)

{
  "success": true,
  "message": "User hi55@quranreflect.com was invited successfully to room testmego123"
}

Loading...