Get Started
Portal api methods
Help

PUT api/2.0/people/type/{type} This function requires authentication

Description

Changes the type between user and guest for the user with the ID specified in the request

Parameters
Name Description Type Example
type
sent in url
New user type All, User, Visitor
userIds
sent in body
User ID list Collection of guids
collection
9924256A-739C-462b-AF15-E652A3B1B6EB
Example
PUT api/2.0/people/type/All
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

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

User list

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "userName": "Mike.Zanyatski",
      "isVisitor": false,
      "firstName": "Mike",
      "lastName": "Zanyatski",
      "email": "my@gmail.com",
      "birthday": "2019-12-15T06:37:50.7585908Z",
      "sex": "male",
      "status": 1,
      "activationStatus": 0,
      "terminated": "2019-12-15T06:37:50.7585908Z",
      "department": "Marketing",
      "workFrom": "2019-12-15T06:37:50.7585908Z",
      "location": "Palo Alto",
      "notes": "Notes to worker",
      "displayName": null,
      "title": "Manager",
      "contacts": [
        {
          "type": "GTalk",
          "value": "my@gmail.com"
        }
      ],
      "groups": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Group Name",
          "manager": "Jake.Zazhitski"
        }
      ],
      "avatarMedium": "url to medium avatar",
      "avatar": "url to big avatar",
      "isAdmin": false,
      "isLDAP": false,
      "listAdminModules": [
        "projects",
        "crm"
      ],
      "isOwner": false,
      "cultureName": "en-EN",
      "isSSO": false,
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>00000000-0000-0000-0000-000000000000</id>
    <userName>Mike.Zanyatski</userName>
    <isVisitor>false</isVisitor>
    <firstName>Mike</firstName>
    <lastName>Zanyatski</lastName>
    <email>my@gmail.com</email>
    <birthday>2019-12-15T06:37:50.7585908Z</birthday>
    <sex>male</sex>
    <status>1</status>
    <activationStatus>0</activationStatus>
    <terminated>2019-12-15T06:37:50.7585908Z</terminated>
    <department>Marketing</department>
    <workFrom>2019-12-15T06:37:50.7585908Z</workFrom>
    <location>Palo Alto</location>
    <notes>Notes to worker</notes>
    <displayName />
    <title>Manager</title>
    <contacts>
      <type>GTalk</type>
      <value>my@gmail.com</value>
    </contacts>
    <groups>
      <id>00000000-0000-0000-0000-000000000000</id>
      <name>Group Name</name>
      <manager>Jake.Zazhitski</manager>
    </groups>
    <avatarMedium>url to medium avatar</avatarMedium>
    <avatar>url to big avatar</avatar>
    <isAdmin>false</isAdmin>
    <isLDAP>false</isLDAP>
    <listAdminModules>projects</listAdminModules>
    <listAdminModules>crm</listAdminModules>
    <isOwner>false</isOwner>
    <cultureName>en-EN</cultureName>
    <isSSO>false</isSSO>
    <avatarSmall>url to small avatar</avatarSmall>
    <profileUrl></profileUrl>
  </response>
</result>