Get Started
Portal api methods
Help

PUT api/2.0/group/{groupid} This function requires authentication

Description

Updates an existing group changing the group manager, name and/or users

Parameters
Name Description Type Example
groupid
sent in url
Group ID guid 9924256A-739C-462b-AF15-E652A3B1B6EB
groupManager
sent in body
Group manager guid 9924256A-739C-462b-AF15-E652A3B1B6EB
groupName
sent in body
Group name string some text
members
sent in body
List of group users Collection of guids
collection
9924256A-739C-462b-AF15-E652A3B1B6EB
Example
PUT api/2.0/group/9924256A-739C-462b-AF15-E652A3B1B6EB
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "groupManager": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "groupName": "some text",
  "members": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
Returns

Newly created group

Example Response

application/json

{
  "status": 0,
  "response": {
    "id": "716ce49c-19f5-43a8-ac3e-acd3c5c31051",
    "name": "Sample group",
    "category": "aa18cdf9-cac5-4086-ae8e-973a7f3b7bdb",
    "parent": "4008b24b-02a4-4b7f-8cf8-98d969138510",
    "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>716ce49c-19f5-43a8-ac3e-acd3c5c31051</id>
    <name>Sample group</name>
    <category>aa18cdf9-cac5-4086-ae8e-973a7f3b7bdb</category>
    <parent>4008b24b-02a4-4b7f-8cf8-98d969138510</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>