Get Started
Usage API
More information

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

Description

Updates the data for the selected portal user with the first name, last name, email address and/or optional parameters specified in the request.

Parameters
Name Description Type Example
userid
sent in url
User ID string some text
isVisitor
sent in body
Specifies if this is a guest (true) or user (false) Bool value true
firstname
sent in body
New user first name string some text
lastname
sent in body
New user last name string some text
comment
sent in body
New user comments
optional
string some text
department
sent in body
New user department
optional
Collection of Guids
title
sent in body
New user title
optional
string some text
location
sent in body
New user location
optional
string some text
sex
sent in body
New user sex (male or female)
optional
string some text
birthday
sent in body
New user birthday
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
worksfrom
sent in body
New user registration date. If it is not specified, then the current date will be set
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
contacts
sent in body
New contact list Collection of Contacts
collection
contacts[0][Type]=GTalk&contacts[0][Value]=my@gmail.com
files
sent in body
New avatar photo URL string some text
disable
sent in body
Disable user
optional
Bool value true
Example
PUT api/2.0/people/some+text
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "isVisitor": true,
  "firstname": "some text",
  "lastname": "some text",
  "comment": "some text",
  "department": [
    "9924256a-739c-462b-af15-e652a3b1b6eb",
    "98777e9c-f2a7-4e97-b314-ba9f92c2e882"
  ],
  "title": "some text",
  "location": "some text",
  "sex": "some text",
  "birthday": "2008-04-10T06-30-00.000Z",
  "worksfrom": "2008-04-10T06-30-00.000Z",
  "contacts": [
    {
      "Type": "GTalk",
      "Value": "my@gmail.com"
    }
  ],
  "files": "some text",
  "disable": null
}
Returns

Updated user

Example Response

application/json

{
  "status": 0,
  "response": {
    "id": "00000000-0000-0000-0000-000000000000",
    "userName": "Mike.Zanyatski",
    "isVisitor": false,
    "firstName": "Mike",
    "lastName": "Zanyatski",
    "email": "my@domain.com",
    "birthday": "2021-10-22T16:42:23.5421342Z",
    "sex": "male",
    "status": 1,
    "activationStatus": 0,
    "terminated": null,
    "department": "Marketing",
    "workFrom": "2021-10-22T16:42:23.5421342Z",
    "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@domain.com</email>
    <birthday>2021-10-22T16:42:23.5421342Z</birthday>
    <sex>male</sex>
    <status>1</status>
    <activationStatus>0</activationStatus>
    <terminated />
    <department>Marketing</department>
    <workFrom>2021-10-22T16:42:23.5421342Z</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>