Group settings API

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Deperacted, please use Group show api

Path Parameters

group_id string required

Query Parameters

client_auth_token string required

Client API token

Header Parameters

access-token string
Example: Y6mJbirKHiocRo9hbIEOZg
client string
Example: 4JQBBvRtNrjfrlCMICewNw
expiry string
Example: 1535368133
token-type string
Example: Bearer
uid string
Example: qr_test_2@quranreflect.com

Responses

• 200

---

OK

Response Headers

application/json

Schema

Example (from schema)

example-0

example-1

---

Schema

object

{}

Group settings API

{
  "success": true,
  "page": {
    "id": 11,
    "name": "testcuu",
    "description": "jdkbkbdska",
    "link": "http://localhost:3000/groups/testcurrent",
    "current_user_is_admin?": true,
    "members_count": 4,
    "invitation_link": "http://localhost:3000/groups/ahmgwGbPC4S8-Cax2px3/invite_all",
    "members": [
      {
        "id": 13,
        "username": "qr_test",
        "name": "ahmed",
        "followed": false,
        "is_admin?": true
      },
      {
        "id": 25,
        "username": "ahme123",
        "name": "ahmed",
        "followed": false,
        "is_admin?": false
      },
      {
        "id": 14,
        "username": "qr_test_1",
        "name": "ahmed",
        "followed": false,
        "is_admin?": false
      },
      {
        "id": 15,
        "username": "qr_test_2",
        "name": "ahmed",
        "followed": false,
        "is_admin?": false
      }
    ]
  }
}

Group settings API (user is not admin)

{
  "success": false,
  "message": "Unauthorized request. require page admin role."
}

Loading...