Get Started
Usage API
More information

POST api/2.0/group/{groupid}/members This function requires authentication

Description

Manages the group members deleting the current members and setting new ones specified in the request instead.

Parameters
Name Description Type Example
groupid
sent in url
Group ID guid 9924256A-739C-462b-AF15-E652A3B1B6EB
members
sent in body
List of new members Collection of guids
collection
9924256A-739C-462b-AF15-E652A3B1B6EB
Example
POST api/2.0/group/9924256A-739C-462b-AF15-E652A3B1B6EB/members
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "members": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
Returns

Group information

Example Response

application/json

{
  "status": 0,
  "response": {
    "id": "52bd0cdf-0d08-4b00-9baa-a2d35f0a2d06",
    "name": "Sample group",
    "category": "5e8ada20-fd21-491f-a020-fa2bc316c749",
    "parent": "94628696-ea77-4a82-bad8-d510c52971eb",
    "description": null,
    "manager": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "members": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      }
    ]
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>52bd0cdf-0d08-4b00-9baa-a2d35f0a2d06</id>
    <name>Sample group</name>
    <category>5e8ada20-fd21-491f-a020-fa2bc316c749</category>
    <parent>94628696-ea77-4a82-bad8-d510c52971eb</parent>
    <description />
    <manager>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </manager>
    <members>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </members>
  </response>
</result>