PUT api/2.0/people/{userid}
Updates the data for the selected portal user with the first name, last name, email address, and/or optional parameters specified in the request.
Name |
Description |
Type |
Example |
isVisitor
sent in body
|
Specifies if this is a guest (true) or user (false)
|
Bool value
|
true
|
userid
sent in body
|
User ID
|
string
|
some text
|
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 comment
optional
|
string
|
some text
|
department
sent in body
|
New user department
optional
|
Collection of Guids
|
9924256A-739C-462b-AF15-E652A3B1B6EB
|
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
|
Specifies whether to disable a user on the portal or not
optional
|
Bool value
|
true
|
PUT api/2.0/people/{userid}
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
{
"isVisitor": true,
"userid": "some text",
"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": true
}
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": "2008-04-10T06-30-00.000Z",
"Sex": "male",
"Status": 1,
"ActivationStatus": 0,
"Terminated": "2008-04-10T06-30-00.000Z",
"Department": "Marketing",
"WorkFrom": "2008-04-10T06-30-00.000Z",
"Location": "Palo Alto",
"Notes": "Notes to worker",
"DisplayName": "Mike Zanyatski",
"MobilePhone": "MobilePhone",
"MobilePhoneActivationStatus": "1",
"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": "\\/Products\\/People\\/Profile.aspx?user=administrator"
}
}
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>2008-04-10T06-30-00.000Z</Birthday>
<Sex>male</Sex>
<Status>1</Status>
<ActivationStatus>0</ActivationStatus>
<Terminated>2008-04-10T06-30-00.000Z</Terminated>
<Department>Marketing</Department>
<WorkFrom>2008-04-10T06-30-00.000Z</WorkFrom>
<Location>Palo Alto</Location>
<Notes>Notes to worker</Notes>
<DisplayName>Mike Zanyatski</DisplayName>
<MobilePhone>MobilePhone</MobilePhone>
<MobilePhoneActivationStatus>1</MobilePhoneActivationStatus>
<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>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
</response>
</result>